blob: b54facd6a341b6416af278bc226f4bb6bde43d36 [file] [log] [blame]
// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// The query packages implement Vanadium's query capabilities.
//
// syncql: This package is used by client's 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.
// - A function to parse an error to get the
// offset into a query that caused the error.
// syncql does does not include the Exec function
// as that must be provided by the component that
// supports queries.
//
// engine: This is the query engine. A component that
// supports queries calls the Exec function in this
// package.
//
// datasource: This package contains the interfaces that a
// Vanadium component must implement in order to
// use the query engine.
//
// internal: This is internal code which implements queries.
// Its sole client is the engine package.
package query