API Reference

This section contains the complete API reference for the MatrixOne Python SDK.

Core Classes

• Client
  • Client Class
  • ResultSet Class
  • Session Class
• AsyncClient
  • AsyncClient Class
  • AsyncResultSet Class

ORM and Query Building

• ORM Classes
  • Query
  • BaseMatrixOneQuery
  • MatrixOneQuery
  • CTE
  • LogicalIn
  • logical_in
• Query Builders
  • MatrixOneSQLBuilder
  • DistanceFunction

Vector Operations

• Vector Type Extensions
  • VectorType
  • Usage Examples
• Vector Index Extensions
  • VectorIndex
  • HNSWConfig
  • IVFConfig
  • Usage Examples
• Vector Manager
  • VectorManager
  • VectorTableBuilder

Fulltext Search

• Fulltext Index Extensions
  • FulltextIndex
  • FulltextSearchBuilder
  • FulltextAlgorithmType
  • FulltextModeType
  • FulltextParserType
  • Usage Examples
• Fulltext Search
  • FulltextFilter
  • FulltextSearchBuilder
  • FulltextQueryBuilder
  • Fulltext Functions

Data Management

• Stage Manager
  • StageManager
  • AsyncStageManager
  • Stage
• Load Data Manager
  • LoadDataManager
  • AsyncLoadDataManager
  • Enumerations
• Export Manager
  • ExportManager
  • AsyncExportManager
• Metadata Manager
  • MetadataManager
  • AsyncMetadataManager
  • Data Classes

Database Management

• Snapshot Manager
  • SnapshotManager
  • Snapshot
  • SnapshotLevel
• Account Manager
  • AccountManager
  • Account
  • User
  • Role
  • Grant
• Restore Manager
  • RestoreManager
• Clone Manager
  • CloneManager
• PITR Manager
  • PitrManager
  • Pitr
• Pub/Sub Manager
  • PubSubManager
  • Publication
  • Subscription
• MoCtl Manager
  • MoCtlManager
• Branch Statement Builders
  • Top-Level Functions
  • Statement Classes
  • Enums
• Clone Statement Builders
  • Top-Level Functions
  • Statement Classes

Utilities

• Result Set
  • ResultSet
  • AsyncResultSet
• Session Classes
  • Session
  • AsyncSession
• Version Manager
  • VersionManager
  • VersionInfo
  • FeatureRequirement
  • Version Functions
• Logger
  • MatrixOneLogger
  • Logger Functions
• CLI Tools
  • MatrixOneCLI Class
  • Helper Functions
  • Utility Functions
  • Colors Class
  • MODiagCompleter Class
  • See Also