Module proof_of_sql::base::database

Module with database related functionality. In particular, this module contains the accessor traits and the OwnedTable type along with some utility functions to convert between Arrow and OwnedTable.

Modules

• owned_table_utility
  Utility functions for creating OwnedTables and OwnedColumns. These functions are primarily intended for use in tests.
• scalar_and_i256_conversions
  Contains traits for scalar <-> i256 conversions

Structs

• ColumnField
  This type is used to represent the metadata of a column in a table. Namely: it’s name and type.
• ColumnRef
  Reference of a SQL column
• OwnedTable
  A table of data, with schema included. This is simply a map from Identifier to OwnedColumn, where columns order matters. This is primarily used as an internal result that is used before converting to the final result in either Arrow format or JSON. This is the analog of an arrow RecordBatch.
• TableRef
  Expression for an SQL table

Enums

• ArrowArrayToColumnConversionError
  Errors caused by conversions between Arrow and owned types.
• Column
  Represents a read-only view of a column in an in-memory, column-oriented database.
• ColumnOperationError
  Errors from operations on columns.
• ColumnType
  Represents the supported data types of a column in an in-memory, column-oriented database.
• ExpressionEvaluationError
  Errors from evaluation of Expressions.
• LiteralValue
  Represents a literal value.
• OwnedArrowConversionError
  Errors cause by conversions between Arrow and owned types.
• OwnedColumn
  Supported types for OwnedColumn
• OwnedColumnError
  Errors from operations related to OwnedColumns.

Traits

• ArrayRefExt
  This trait is used to provide utility functions to convert ArrayRefs into proof types (Column, Scalars, etc.)
• CommitmentAccessor
  Access commitments of database columns.
• DataAccessor
  Access database columns of an in-memory table span.
• MetadataAccessor
  Access metadata of a table span in a database.
• SchemaAccessor
  Access tables and their schemas in a database.
• ToArrow
  Extension trait for Vec to convert it to an Arrow array

Functions

• try_add_subtract_column_types
  Determine the output type of an add or subtract operation if it is possible to add or subtract the two input types. If the types are not compatible, return an error.
• try_divide_column_types
  Determine the output type of a division operation if it is possible to multiply the two input types. If the types are not compatible, return an error.
• try_multiply_column_types
  Determine the output type of a multiplication operation if it is possible to multiply the two input types. If the types are not compatible, return an error.

Type Aliases

• ColumnOperationResult
  Result type for column operations
• ExpressionEvaluationResult
  Result type for expression evaluation
• OwnedColumnResult
  Result type for operations related to OwnedColumns.