Skip to main content

Module query

Module query 

Source
Expand description

Query module

Re-exports§

pub use conditions::ValueClause;
pub use conditions::WhereClause;
pub use conditions::WhereOperator;
pub use drive_document_average_query::AverageEntry;
pub use drive_document_average_query::AverageMode;
pub use drive_document_count_query::CountMode;
pub use drive_document_count_query::DocumentCountMode;
pub use drive_document_count_query::DriveDocumentCountQuery;
pub use drive_document_count_query::SplitCountEntry;
pub use drive_document_sum_query::DriveDocumentSumQuery;
pub use drive_document_sum_query::SumEntry;
pub use drive_document_sum_query::SumMode;
pub use having::HavingAggregate;
pub use having::HavingAggregateFunction;
pub use having::HavingClause;
pub use having::HavingOperator;
pub use having::HavingRanking;
pub use having::HavingRankingKind;
pub use having::HavingRightOperand;
pub use ordering::OrderClause;
pub use projection::SelectFunction;
pub use projection::SelectProjection;
pub use vote_polls_by_end_date_query::VotePollsByEndDateDriveQuery;
pub use vote_query::IdentityBasedVoteDriveQuery;
pub use drive_document_count_query::DocumentCountRequest;
pub use drive_document_count_query::DocumentCountResponse;
pub use drive_document_count_query::RangeCountOptions;
pub use drive_document_count_query::MAX_LIMIT_AS_FAILSAFE;
pub use drive_document_sum_query::DocumentSumRequest;
pub use drive_document_sum_query::DocumentSumResponse;
pub use drive_document_sum_query::RangeSumOptions;
pub use drive_document_average_query::DocumentAverageRequest;
pub use drive_document_average_query::DocumentAverageResponse;

Modules§

conditions
Query Conditions
contested_resource_votes_given_by_identity_query
A query to get the votes given out by an identity
drive_contested_document_query
A query to get contested documents before they have been awarded
drive_document_average_query
A query to compute the average of an integer property across documents using CountSumTree / ProvableCountProvableSumTree (PCPS) elements. Averages are NOT computed server-side; the response carries a (count, sum) pair (atomic per group) and the client divides. See book/src/drive/average-index-examples.md for the worked example contract. DriveDocumentAverageQuery — Drive’s average-query surface.
drive_document_count_and_sum_query
Joint count-and-sum no-prove executor surface — backs the AVG no-prove path’s unified single-walk dispatch. See its module docstring for the perf / atomicity contract. Server-only because the surface only fires on the no-prove (server-materialized) path. Joint count-and-sum executor surface for the AVG no-prove path.
drive_document_count_query
A query to count documents using CountTree elements Types and module structure for the GetDocumentsCount query.
drive_document_sum_query
A query to sum an integer property across documents using SumTree elements. Parallels drive_document_count_query for the sum surface — see book/src/drive/document-sum-trees.md for the design and book/src/drive/sum-index-examples.md for the worked example contract. DriveDocumentSumQuery — Drive’s sum-query surface.
filter
Document subscription filtering Document subscription filtering
having
HAVING clause types for the v1 getDocuments count surface.
identity_token_balance_drive_query
A query to get the identity’s token balance
identity_token_info_drive_query
A query to get the identity’s token info
ordering
Query Ordering
projection
SELECT projection types for the v1 getDocuments surface.
proposer_block_count_query
A query to get the block counts of proposers in an epoch
token_status_drive_query
A query to get the token’s status
vote_poll_contestant_votes_query
Vote poll contestant votes query module
vote_poll_vote_state_query
Vote poll vote state query module
vote_polls_by_document_type_query
Vote polls by document type query
vote_polls_by_end_date_query
Vote polls by end date query
vote_query
Vote Query module

Structs§

DriveDocumentQuery
Drive query struct
InternalClauses
Internal clauses struct
PathQuery
Path query
Query
Query represents one or more keys or ranges of keys, which can be used to resolve a proof which will include all the requested values.
QueryResultElements
Query result elements
SingleDocumentDriveQuery
Drive query struct
SizedQuery
Holds a query to apply to a tree and an optional limit/offset value. Limit and offset values affect the size of the result set.
StartAtDocument
Represents a starting point for a query based on a specific document.

Enums§

Element
Variants of GroveDB stored entities
GroveError
GroveDB Errors
QueryItem
A QueryItem represents a key or a range of keys to be included in a proof.
QueryResultType
Query result type
SingleDocumentDriveQueryContestedStatus
The expected contested status of a document Drives stores the document in either the not contested location (most of the time) Or a temporary contested area while the contest is ongoing

Functions§

contract_lookup_fn_for_contract
Creates a ContractLookupFn function that returns provided data contract when requested.

Type Aliases§

ContractLookupFn
Function type for looking up a contract by identifier
QuerySyntaxSimpleValidationResult
A Query Syntax Validation Result
QuerySyntaxValidationResult
A Query Syntax Validation Result that contains data
TransactionArg
TransactionArg