Documentation
¶
Overview ¶
The query packages implement Vanadium's query capabilities.
The syncql package is used by clients of a Vanadium component that supports queries. It includes: ResultStream (which is the product of executing a query), the error messages that could be returned from performing a query, and a function to parse an error to get the offset into a query that caused the error. syncql does not include the Exec function as that must be provided by the component that supports queries.
The engine package implements the query engine. A component that supports queries calls the Exec function in this package.
The datasource package contains the interfaces that a Vanadium component must implement in order to use the query engine.
The internal package provides a reference implementation of the queries package. Its sole client is the engine package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package engine defines a Create function which returns an instance of datasource.QueryEngine
|
Package engine defines a Create function which returns an instance of datasource.QueryEngine |
|
datasource
Package datasource defines the interfaces a system must implement to support querying.
|
Package datasource defines the interfaces a system must implement to support querying. |
|
internal
Package internal implements Exec, executing SQL-like queries on a given database.
|
Package internal implements Exec, executing SQL-like queries on a given database. |
|
internal/query_checker
Package query_checker performs a semantic check on an AST produced by the query_parser package.
|
Package query_checker performs a semantic check on an AST produced by the query_parser package. |
|
internal/query_functions
Package query_functions describes SyncQL's built-in functions.
|
Package query_functions describes SyncQL's built-in functions. |
|
internal/query_parser
Package query_parser is a parser to parse a simplified select statement (a la SQL) for the Vanadium key value store (a.k.a., syncbase).
|
Package query_parser is a parser to parse a simplified select statement (a la SQL) for the Vanadium key value store (a.k.a., syncbase). |
|
internal/test
Package query_test contains tests for the query package.
|
Package query_test contains tests for the query package. |
|
public
Package public defines the QueryEngine interface which is returned from calling v.io/v23/query/engine.Create and PreparedStatement which is returned from the QueryEngine.PrepareStatement function.
|
Package public defines the QueryEngine interface which is returned from calling v.io/v23/query/engine.Create and PreparedStatement which is returned from the QueryEngine.PrepareStatement function. |
|
The ResultStream interface is used to iterate over query results.
|
The ResultStream interface is used to iterate over query results. |