matrixone-python-sdk 0.1.12__tar.gz → 0.1.14__tar.gz

{matrixone_python_sdk-0.1.12/matrixone_python_sdk.egg-info → matrixone_python_sdk-0.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrixone-python-sdk
-Version: 0.1.12
+Version: 0.1.14
 Summary: A comprehensive Python SDK for MatrixOne database operations with vector search, fulltext search, and advanced features
 Home-page: https://github.com/matrixorigin/matrixone
 Author: MatrixOne Team
@@ -87,6 +87,9 @@ A comprehensive, high-level Python SDK for MatrixOne that provides SQLAlchemy-li
 - 📋 [Best Practices](https://matrixone.readthedocs.io/en/latest/best_practices.html)
 - 📖 [API Reference](https://matrixone.readthedocs.io/en/latest/api/index.html)
 
+**For Developers:**
+- 🛠️ [MatrixOne Development Guide](../../etc/DEV_README.md) - Complete guide for setting up MatrixOne locally, multi-CN clusters, monitoring, and all `make dev-*` commands
+
 ---
 
 ## ✨ Features
@@ -205,6 +208,13 @@ class User(Base):
 
 ## Quick Start
 
+> **💡 Need to set up MatrixOne server?**  
+> If you don't have MatrixOne running yet, check out the [MatrixOne Development Guide](../../etc/DEV_README.md) for instructions on:
+> - Starting a standalone MatrixOne instance
+> - Setting up a multi-CN cluster with Docker Compose
+> - Enabling monitoring and metrics
+> - All `make dev-*` commands
+
 ### Basic Usage
 
 ```python

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/README.md

@@ -22,6 +22,7 @@ A comprehensive Python SDK for MatrixOne that provides SQLAlchemy-like interface
   - Support for f32 and f64 precision vectors
   - Multiple distance metrics (L2, Cosine, Inner Product)
   - ⭐ **IVF Index Health Monitoring** with `get_ivf_stats()` - Critical for production!
+  - ⭐ **IVF LIMIT BY RANK** - Fine-grained ranking control (pre/post/force modes)
   - Configurable index parameters for performance tuning
 - 🔍 **Fulltext Search**: Powerful fulltext indexing and search with BM25 and TF-IDF algorithms
   - Natural language and boolean search modes
@@ -55,6 +56,11 @@ A comprehensive Python SDK for MatrixOne that provides SQLAlchemy-like interface
 - 📸 **Snapshot Management**: Create and manage database snapshots at multiple levels
 - ⏰ **Point-in-Time Recovery**: PITR functionality for precise data recovery
 - 🔄 **Table Cloning**: Clone databases and tables efficiently with data replication
+- 🌿 **Branch Management**: Git-style version control for databases and tables
+  - Create isolated branches for development and testing
+  - Compare differences between branches with count-only optimization
+  - Merge branches with conflict resolution strategies
+  - Point-in-time branching from snapshots
 - 👥 **Account Management**: Comprehensive user, role, and permission management
 - 📊 **Pub/Sub**: Real-time publication and subscription support
 - 🔧 **Version Management**: Automatic backend version detection and compatibility checking

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/README_USER.md

@@ -19,6 +19,9 @@ A comprehensive, high-level Python SDK for MatrixOne that provides SQLAlchemy-li
 - 📋 [Best Practices](https://matrixone.readthedocs.io/en/latest/best_practices.html)
 - 📖 [API Reference](https://matrixone.readthedocs.io/en/latest/api/index.html)
 
+**For Developers:**
+- 🛠️ [MatrixOne Development Guide](../../etc/DEV_README.md) - Complete guide for setting up MatrixOne locally, multi-CN clusters, monitoring, and all `make dev-*` commands
+
 ---
 
 ## ✨ Features
@@ -137,6 +140,13 @@ class User(Base):
 
 ## Quick Start
 
+> **💡 Need to set up MatrixOne server?**  
+> If you don't have MatrixOne running yet, check out the [MatrixOne Development Guide](../../etc/DEV_README.md) for instructions on:
+> - Starting a standalone MatrixOne instance
+> - Setting up a multi-CN cluster with Docker Compose
+> - Enabling monitoring and metrics
+> - All `make dev-*` commands
+
 ### Basic Usage
 
 ```python

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/examples/example_08_pubsub_operations.py

@@ -219,8 +219,7 @@ def demo_cross_account_pubsub():
             host=host, port=port, user="pub_publisher#pub_admin", password="pub_pass", database="publisher_data"
         )
 
-        pub_admin_client.execute(
-            """
+        pub_admin_client.execute("""
             CREATE TABLE IF NOT EXISTS sales_data (
                 id INT PRIMARY KEY AUTO_INCREMENT,
                 product_name VARCHAR(100) NOT NULL,
@@ -228,11 +227,9 @@ def demo_cross_account_pubsub():
                 price DECIMAL(10,2),
                 sale_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
             )
-        """
-        )
+        """)
 
-        pub_admin_client.execute(
-            """
+        pub_admin_client.execute("""
             CREATE TABLE IF NOT EXISTS customer_data (
                 id INT PRIMARY KEY AUTO_INCREMENT,
                 customer_name VARCHAR(100) NOT NULL,
@@ -240,8 +237,7 @@ def demo_cross_account_pubsub():
                 phone VARCHAR(20),
                 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
             )
-        """
-        )
+        """)
 
         # Insert sample data
         pub_admin_client.execute("DELETE FROM sales_data")
@@ -323,14 +319,12 @@ def demo_cross_account_pubsub():
         logger.info(f"   📊 Total sales records: {sales_count}")
 
         # Show sales summary
-        result = pub_admin_client.execute(
-            """
+        result = pub_admin_client.execute("""
             SELECT product_name, SUM(quantity) as total_qty, SUM(quantity * price) as total_value
             FROM sales_data
             GROUP BY product_name
             ORDER BY total_value DESC
-        """
-        )
+        """)
         logger.info("   📋 Sales summary:")
         for row in result.rows:
             logger.info(f"     - {row[0]}: {row[1]} units, ${row[2]:.2f}")
@@ -398,8 +392,7 @@ async def demo_async_pubsub_operations():
         await client.execute("CREATE DATABASE IF NOT EXISTS async_pubsub_test")
         await client.execute("USE async_pubsub_test")
 
-        await client.execute(
-            """
+        await client.execute("""
             CREATE TABLE IF NOT EXISTS events (
                 id INT PRIMARY KEY AUTO_INCREMENT,
                 event_type VARCHAR(50) NOT NULL,
@@ -407,8 +400,7 @@ async def demo_async_pubsub_operations():
                 timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
                 source VARCHAR(100)
             )
-        """
-        )
+        """)
 
         # Insert sample data
         await client.execute("DELETE FROM events")
@@ -474,14 +466,12 @@ async def demo_async_pubsub_operations():
         logger.info(f"   📊 Total events: {event_count}")
 
         # Show event distribution by type
-        result = await client.execute(
-            """
+        result = await client.execute("""
             SELECT event_type, COUNT(*) as count
             FROM events
             GROUP BY event_type
             ORDER BY count DESC
-        """
-        )
+        """)
         logger.info("   📊 Event distribution by type:")
         for row in result.rows:
             logger.info(f"     - {row[0]}: {row[1]} events")
@@ -520,8 +510,7 @@ def demo_pubsub_best_practices():
         client.execute("USE ecommerce")
 
         # Create tables
-        client.execute(
-            """
+        client.execute("""
             CREATE TABLE IF NOT EXISTS products (
                 id INT PRIMARY KEY AUTO_INCREMENT,
                 name VARCHAR(100) NOT NULL,
@@ -530,11 +519,9 @@ def demo_pubsub_best_practices():
                 category VARCHAR(50),
                 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
             )
-        """
-        )
+        """)
 
-        client.execute(
-            """
+        client.execute("""
             CREATE TABLE IF NOT EXISTS orders (
                 id INT PRIMARY KEY AUTO_INCREMENT,
                 customer_id INT,
@@ -544,11 +531,9 @@ def demo_pubsub_best_practices():
                 status VARCHAR(20) DEFAULT 'pending',
                 order_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
             )
-        """
-        )
+        """)
 
-        client.execute(
-            """
+        client.execute("""
             CREATE TABLE IF NOT EXISTS inventory_logs (
                 id INT PRIMARY KEY AUTO_INCREMENT,
                 product_id INT,
@@ -557,8 +542,7 @@ def demo_pubsub_best_practices():
                 change_reason VARCHAR(100),
                 timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP
             )
-        """
-        )
+        """)
 
         # Insert sample data - clear existing data
         try:
@@ -681,8 +665,7 @@ def demo_pubsub_best_practices():
         logger.info("\n📊 Business Analytics")
 
         # Product performance
-        result = client.execute(
-            """
+        result = client.execute("""
             SELECT p.name, p.price, p.stock_quantity,
                    COALESCE(SUM(o.quantity), 0) as total_ordered,
                    COALESCE(SUM(o.total_amount), 0) as total_revenue
@@ -690,15 +673,13 @@ def demo_pubsub_best_practices():
             LEFT JOIN orders o ON p.id = o.product_id
             GROUP BY p.id, p.name, p.price, p.stock_quantity
             ORDER BY total_revenue DESC
-        """
-        )
+        """)
         logger.info("   📋 Product performance:")
         for row in result.rows:
             logger.info(f"     - {row[0]}: ${row[1]}, Stock: {row[2]}, Ordered: {row[3]}, Revenue: ${row[4]:.2f}")
 
         # Inventory status
-        result = client.execute(
-            """
+        result = client.execute("""
             SELECT name, stock_quantity,
                    CASE
                        WHEN stock_quantity > 50 THEN 'High'
@@ -707,8 +688,7 @@ def demo_pubsub_best_practices():
                    END as stock_level
             FROM products
             ORDER BY stock_quantity ASC
-        """
-        )
+        """)
         logger.info("   📋 Inventory status:")
         for row in result.rows:
             logger.info(f"     - {row[0]}: {row[1]} units ({row[2]} stock)")

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/examples/example_13_vector_indexes.py

@@ -564,16 +564,14 @@ class VectorIndexDemo:
 
                     # Create test table
                     await async_client.execute("DROP TABLE IF EXISTS async_fulltext_docs")
-                    await async_client.execute(
-                        """
+                    await async_client.execute("""
                         CREATE TABLE async_fulltext_docs (
                             id INT PRIMARY KEY,
                             headline VARCHAR(200),
                             body TEXT,
                             category VARCHAR(50)
                         )
-                    """
-                    )
+                    """)
                     print("✓ Created async fulltext test table")
 
                     # Create fulltext index

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/examples/example_18_snapshot_orm.py

@@ -69,8 +69,7 @@ class SnapshotORMDemo:
                 client.execute("DROP TABLE IF EXISTS users")
 
                 # Create table
-                client.execute(
-                    """
+                client.execute("""
                     CREATE TABLE users (
                         id INT PRIMARY KEY AUTO_INCREMENT,
                         name VARCHAR(100),
@@ -78,8 +77,7 @@ class SnapshotORMDemo:
                         age INT,
                         department VARCHAR(50)
                     )
-                """
-                )
+                """)
 
                 # Insert test data
                 client.execute(
@@ -157,16 +155,14 @@ class SnapshotORMDemo:
                 await client.execute("DROP TABLE IF EXISTS products")
 
                 # Create table
-                await client.execute(
-                    """
+                await client.execute("""
                     CREATE TABLE products (
                         id INT PRIMARY KEY AUTO_INCREMENT,
                         name VARCHAR(100),
                         price DECIMAL(10,2),
                         category VARCHAR(50)
                     )
-                """
-                )
+                """)
 
                 # Insert test data
                 await client.execute("INSERT INTO products (name, price, category) VALUES ('Laptop', 999.99, 'Electronics')")
@@ -239,18 +235,15 @@ class SnapshotORMDemo:
                 client.execute("DROP TABLE IF EXISTS customers")
 
                 # Create tables
-                client.execute(
-                    """
+                client.execute("""
                     CREATE TABLE customers (
                         id INT PRIMARY KEY AUTO_INCREMENT,
                         name VARCHAR(100),
                         email VARCHAR(100)
                     )
-                """
-                )
+                """)
 
-                client.execute(
-                    """
+                client.execute("""
                     CREATE TABLE orders (
                         id INT PRIMARY KEY AUTO_INCREMENT,
                         customer_id INT,
@@ -258,8 +251,7 @@ class SnapshotORMDemo:
                         amount DECIMAL(10,2),
                         FOREIGN KEY (customer_id) REFERENCES customers(id)
                     )
-                """
-                )
+                """)
 
                 # Insert test data
                 client.execute("INSERT INTO customers (name, email) VALUES ('John', 'john@example.com')")
@@ -330,16 +322,14 @@ class SnapshotORMDemo:
                 client.execute("USE builder_methods_test")
                 client.execute("DROP TABLE IF EXISTS test_data")
 
-                client.execute(
-                    """
+                client.execute("""
                     CREATE TABLE test_data (
                         id INT PRIMARY KEY AUTO_INCREMENT,
                         name VARCHAR(100),
                         value INT,
                         category VARCHAR(50)
                     )
-                """
-                )
+                """)
 
                 # Insert test data
                 client.execute("INSERT INTO test_data (name, value, category) VALUES ('Item1', 10, 'A')")

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/examples/example_22_unified_sql_builder.py

@@ -243,8 +243,7 @@ class UnifiedSQLBuilderDemo:
         try:
             # Create test tables
             self.client.execute("DROP TABLE IF EXISTS test_users_cte")
-            self.client.execute(
-                """
+            self.client.execute("""
                 CREATE TABLE test_users_cte (
                     id INT PRIMARY KEY,
                     name VARCHAR(100),
@@ -252,45 +251,37 @@ class UnifiedSQLBuilderDemo:
                     salary DECIMAL(10,2),
                     email VARCHAR(100)
                 )
-            """
-            )
+            """)
 
             self.client.execute("DROP TABLE IF EXISTS test_departments_cte")
-            self.client.execute(
-                """
+            self.client.execute("""
                 CREATE TABLE test_departments_cte (
                     id INT PRIMARY KEY,
                     name VARCHAR(100),
                     budget DECIMAL(12,2)
                 )
-            """
-            )
+            """)
 
             # Insert sample data
-            self.client.execute(
-                """
+            self.client.execute("""
                 INSERT INTO test_departments_cte (id, name, budget) VALUES 
                 (1, 'Engineering', 100000),
                 (2, 'Marketing', 50000),
                 (3, 'Sales', 80000),
                 (4, 'HR', 30000)
-            """
-            )
+            """)
 
-            self.client.execute(
-                """
+            self.client.execute("""
                 INSERT INTO test_users_cte (id, name, department_id, salary, email) VALUES 
                 (1, 'John Doe', 1, 75000, 'john@example.com'),
                 (2, 'Jane Smith', 1, 80000, 'jane@example.com'),
                 (3, 'Bob Johnson', 2, 60000, 'bob@example.com'),
                 (4, 'Alice Brown', 3, 70000, 'alice@example.com'),
                 (5, 'Charlie Wilson', 4, 55000, 'charlie@example.com')
-            """
-            )
+            """)
 
             # Test CTE with department statistics using new CTE support
-            results = self.client.execute(
-                """
+            results = self.client.execute("""
                 WITH dept_stats AS (
                     SELECT 
                         department_id, 
@@ -308,16 +299,14 @@ class UnifiedSQLBuilderDemo:
                 FROM dept_stats
                 WHERE avg_salary > 65000
                 ORDER BY avg_salary DESC
-            """
-            )
+            """)
 
             print(f"✅ CTE department statistics: {len(results)} results")
             for row in results:
                 print(f"    Dept {row.department_id}: {row.user_count} users, avg: ${row.avg_salary:.2f}")
 
             # Test CTE with JOINs using new CTE support
-            results2 = self.client.execute(
-                """
+            results2 = self.client.execute("""
                 WITH high_salary_users AS (
                     SELECT id, name, department_id, salary 
                     FROM test_users_cte 
@@ -330,8 +319,7 @@ class UnifiedSQLBuilderDemo:
                 FROM high_salary_users
                 INNER JOIN test_departments_cte d ON high_salary_users.department_id = d.id
                 ORDER BY high_salary_users.salary DESC
-            """
-            )
+            """)
 
             print(f"✅ CTE with JOINs: {len(results2)} results")
             for row in results2:

{matrixone_python_sdk-0.1.12 → matrixone_python_sdk-0.1.14}/examples/example_29_complex_queries.py

@@ -158,30 +158,25 @@ class ComplexQueryDemo:
         self.client.create_table(Embedding)
 
         # Insert categories
-        self.client.execute(
-            """
+        self.client.execute("""
             INSERT INTO categories_complex (category_name) VALUES
             ('Electronics'),
             ('Clothing'),
             ('Books')
-        """
-        )
+        """)
 
         # Insert products
-        self.client.execute(
-            """
+        self.client.execute("""
             INSERT INTO products_complex (product_name, description, category_id, price) VALUES
             ('Laptop', 'High performance laptop for coding', 1, 999.99),
             ('Smartphone', 'Latest smartphone with great camera', 1, 699.99),
             ('T-Shirt', 'Comfortable cotton t-shirt', 2, 19.99),
             ('Python Book', 'Learn Python programming', 3, 39.99),
             ('ML Book', 'Machine learning fundamentals', 3, 49.99)
-        """
-        )
+        """)
 
         # Insert reviews
-        self.client.execute(
-            """
+        self.client.execute("""
             INSERT INTO reviews_complex (product_id, rating, comment) VALUES
             (1, 5, 'Excellent laptop for development'),
             (1, 4, 'Good value for money'),
@@ -189,8 +184,7 @@ class ComplexQueryDemo:
             (3, 3, 'Decent quality'),
             (4, 5, 'Great for beginners'),
             (5, 5, 'Very insightful')
-        """
-        )
+        """)
 
         # Insert embeddings with vectors
         def generate_vector(dim=64):
@@ -200,14 +194,12 @@ class ComplexQueryDemo:
                 vec = [random.random() for _ in range(dim)]
             return '[' + ','.join(map(str, vec)) + ']'
 
-        self.client.execute(
-            f"""
+        self.client.execute(f"""
             INSERT INTO embeddings_complex (category_id, text, vector) VALUES
             (1, 'tech gadgets', '{generate_vector(64)}'),
             (2, 'fashion apparel', '{generate_vector(64)}'),
             (3, 'educational content', '{generate_vector(64)}')
-        """
-        )
+        """)
 
         print("✓ Test data populated\n")