API Reference

Connections

Connections to SingleStoreDB should be done by creating an SQLAlchemy engine first, then calling the connect() method on that engine. See the Getting Started section for more information.

The dialect class below is used by SQLAlchemy, but is typically not worked with directly.

Dialect

SingleStoreDBDialect([isolation_level, ...])	SingleStoreDB SQLAlchemy dialect.
SingleStoreDBDialect.dbapi()
SingleStoreDBDialect.import_dbapi()	Import the DBAPI module that is used by this dialect.
SingleStoreDBDialect.initialize(connection)	Called during strategized creation of the dialect with a connection.
SingleStoreDBDialect.create_connect_args(url)	Build DB-API compatible connection arguments.

DDL Elements

SingleStoreDB-specific DDL elements for table definition.

ShardKey(*columns[, index_type, metadata_only])	SingleStore SHARD KEY DDL element.
SortKey(*columns)	SingleStore SORT KEY DDL element.
VectorKey(*columns[, name, index_options])	SingleStore VECTOR INDEX DDL element.
MultiValueIndex(*columns[, index_options])	SingleStore MULTI VALUE INDEX DDL element.
FullTextIndex(*columns[, name, version])	SingleStore FULLTEXT INDEX DDL element.
ColumnGroup(*[, name])	SingleStore COLUMN GROUP DDL element.

Table Types

Table storage type specifications for rowstore and columnstore tables.

RowStore([reference, temporary, ...])	SingleStore rowstore table type specification.
ColumnStore([reference, temporary])	SingleStore columnstore table type specification.

Data Types

SingleStoreDB-specific data types.

VECTOR([n_elems, elem_type])	SingleStore VECTOR data type for storing fixed-dimension vectors.
JSON(*args, **kwargs)	SingleStore JSON data type for storing structured JSON data.
PersistedColumn(*args[, persisted_expression])	SingleStore computed column that is automatically calculated and stored.