Skip to main content

Crate corro_api_types

Crate corro_api_types 

Source

Modules§

sqlite

Structs§

ChangeId
ChangeId newtype to differentiate from RowId
ColumnName
An SQL column name, stored as a CompactString.
ExecResponse
Response returned by the /v1/transactions and /v1/migrations endpoints.
HealthQuery
HealthQuery represents the query string for the /v1/health endpoint.
Real
RowId
RowId newtype to differentiate from ChangeId
SqliteValueRef
TableName
Sqlite table name, stored as a CompactString.
TableStatRequest
Request body for the /v1/table-stats endpoint.
TableStatResponse
Contain node and sync status information

Enums§

ColumnType
SQLite storage class for a column or value.
ExecResult
Result of executing a single statement.
HealthResponse
Contains status information about the node
QueryEventMeta
Lightweight enum describing a TypedQueryEvent
SqliteParam
A parameter value that can be bound to a Statement
SqliteValue
Statement
A SQL statement, optionally with bound parameters.
TypedNotifyEvent
TypedNotifyEvent represents the different events that an update stream can produce.
TypedQueryEvent
TypedQueryEvent represents the different events that a query or subscription can produce. It wraps T which is the type used to represent a row.

Constants§

QUERY_HASH_HEADER
HTTP response header that carries a hash of the SQL query string. Returned alongside QUERY_ID_HEADER so clients can verify that a cached subscription ID still corresponds to the same query.
QUERY_ID_HEADER
HTTP response header that carries the UUID of a subscription or update stream. Set by the server on every successful /v1/queries, /v1/subscriptions, and /v1/updates response so callers can re-attach to the same stream by ID.

Type Aliases§

NotifyEvent
Untyped variant of TypedNotifyEvent, where each payload is a Vec of SqliteValue.
QueryEvent
Untyped variant of TypedQueryEvent, where each row is a Vec of SqliteValue.