{"path": "10.doc-overview.md", "description": "This document provides an overview of seekdb's documentation, including getting started guides, SDK and API examples, deployment modes (embedded and server), and resources for building AI applications with hybrid search capabilities.", "branch": "V1.1.0"}
{"path": "100.get-started/10.overview/10.seekdb-overview.md", "description": "This document provides an overview of OceanBase seekdb, an AI-native search database that unifies relational, vector, text, JSON, and GIS data models in a single engine. It details seekdb's hybrid search capabilities, multi-model architecture, AI-in-database functions, deployment modes, and use cases such as RAG, semantic search, AI-assisted programming, and agentic AI applications.", "branch": "V1.0.0"}
{"path": "100.get-started/10.seekdb-overview/10.seekdb-overview.md", "description": "This document provides an overview of OceanBase seekdb, an AI-native search database that unifies relational, vector, text, JSON, and GIS data models in a single engine. It details seekdb's hybrid search capabilities, multi-model architecture, built-in AI functions, deployment modes, and use cases such as RAG, semantic search, AI-assisted programming, and agentic AI applications.", "branch": "V1.1.0"}
{"path": "100.get-started/100.use-seekdb-with-sql/10.deploy-seekdb-testing-environment.md", "description": "This document provides a step-by-step guide to deploying and using seekdb in client/server mode with SQL, covering installation on various platforms (CentOS/RHEL, Debian/Ubuntu, macOS, Docker), connecting via MySQL client, creating databases and tables with vector and full-text indexes, inserting sample data, and performing hybrid search queries with boosting.", "branch": "V1.1.0"}
{"path": "100.get-started/100.use-seekdb-with-sql/5.experience-vector-search-with-sql.md", "description": "This document provides a step-by-step guide to performing vector search using SQL in seekdb, covering deployment in client/server mode, table creation with vector columns and indexes, data insertion, and executing approximate nearest neighbor searches.", "branch": "V1.1.0"}
{"path": "100.get-started/110.use-seekdb-with-skill/100.agent-skills.md", "description": "This document explains how to use seekdb Agent Skills—predefined knowledge packs and workflows that enable AI tools like Cursor, Claude Code, and OpenClaw to interact with seekdb by consulting documentation, importing/exporting data, and performing hybrid searches—along with installation instructions and usage examples.", "branch": "V1.0.0"}
{"path": "100.get-started/200.ai-coding/100.building-personal-knowledge-base-through-ai-dialogue-using-seekdb-mcp-server.md", "description": "This document explains how to build a personal knowledge base using seekdb's MCP server in embedded mode, enabling AI coding tools like Cursor to save, semantically search, and retrieve notes via natural-language dialogue—with support for hybrid search and persistent AI memory.", "branch": "V1.1.0"}
{"path": "100.get-started/200.ai-coding/200.building-an-ai-programming-assistant-that-understands-vector-databases-with-seekdb-claude-code.md", "description": "This document explains how to build a vector-aware AI coding assistant using seekdb and Claude Code by installing the seekdb Agent Skill plugin, enabling accurate, documentation-backed responses for hybrid search applications in Python.", "branch": "V1.1.0"}
{"path": "100.get-started/200.ai-coding/300.making-cursor-ai-instantly-understand-seekdb-a-guide-to-using-the-seekdb-cursor-extension.md", "description": "This document explains how to use the seekdb Cursor Extension to enable Cursor AI to understand and generate accurate, up-to-date code for seekdb— an AI-native search database—by injecting official documentation and rules into your project, with a step-by-step guide to building a hybrid search demo in Python.", "branch": "V1.1.0"}
{"path": "100.get-started/5.changelog/10.changelog.md", "description": "This document provides the changelog for OceanBase seekdb, detailing new features, improvements, and fixes across releases of seekdb, pyseekdb, and seekdb-js—including macOS support, FORK TABLE, enhanced full-text and vector search, expanded embedding integrations, and flexible collection naming.", "branch": "V1.0.0"}
{"path": "100.get-started/50.use-seekdb-with-sdk/10.experience-vector-search-with-sdk.md", "description": "This document provides a step-by-step guide to performing vector search using the pyseekdb Python SDK with embedded seekdb, covering installation, database and collection setup, data insertion, querying, and cleanup.", "branch": "V1.1.0"}
{"path": "100.get-started/50.use-seekdb-with-sdk/25.using-seekdb-in-python-sdk.md", "description": "This document provides a step-by-step guide to performing hybrid search using the pyseekdb Python SDK with embedded seekdb, covering installation, database and collection setup, data insertion, hybrid querying, and cleanup.", "branch": "V1.1.0"}
{"path": "200.develop/10.develop-overview/10.develop-overview.md", "description": "This document provides an overview of development options for seekdb, including using the Python SDK (pyseekdb) for embedded or remote database connections and leveraging SQL with MySQL-compatible drivers for multi-model data management and hybrid search.", "branch": "V1.1.0"}
{"path": "200.develop/10.overview/10.develop-overview.md", "description": "This document provides an overview of seekdb development options, including using the Python SDK (pyseekdb) for embedded or remote database connections and leveraging SQL for multi-model data management and hybrid searches.", "branch": "V1.0.0"}
{"path": "200.develop/100.connect-to-seekdb/100.connection-methods-overview.md", "description": "This document provides an overview of the various methods to connect to seekdb, including using command-line clients (like MySQL client), language-specific drivers (C, Go, Java, PHP, Python), ORM frameworks (such as GORM, Hibernate, MyBatis, Spring Data JPA), and database connection pools (like HikariCP, C3P0, Tomcat).", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/200.use-client-connect-seekdb/100.connect-to-seekdb-by-using-a-mysql-client.md", "description": "This document explains how to connect to seekdb using a MySQL client, including prerequisites, connection parameters, command examples, and troubleshooting tips.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/100.connect-to-seekdb-through-spring-boot.md", "description": "This document provides a step-by-step guide for connecting to seekdb using a Spring Boot sample application, including prerequisites, configuration of database connection properties in `application.properties`, project setup in IntelliJ IDEA, and example operations like creating tables and querying data.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/200.connect-to-seekdb-through-spring-batch.md", "description": "This document provides a step-by-step guide on connecting to seekdb using the Spring Batch framework in Java, including project setup, configuration of database connection properties, and sample code execution for basic data operations like table creation, insertion, and querying.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/300.connect-to-seekdb-through-spring-jdbc.md", "description": "This document provides a step-by-step guide for connecting to seekdb using Spring JDBC in a Java application, including setup, configuration, and sample code for basic database operations like CRUD, transaction management, and connection pooling.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/400.connect-to-seekdb-through-springjpa.md", "description": "This document provides a step-by-step guide for connecting to seekdb using Spring Data JPA in a Java application, including prerequisites, configuration of database connection settings in `application.yml`, project setup in IntelliJ IDEA, and sample code execution for basic CRUD operations.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/500.connect-to-seekdb-through-hibernate.md", "description": "This document provides a step-by-step guide on connecting to seekdb using the Hibernate framework in Java, including prerequisites, configuration of `hibernate.cfg.xml`, sample code execution, and troubleshooting common issues like connection timeouts, character encoding, SSL setup, and handling special characters in credentials.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/600.connect-to-seekdb-through-mybatis.md", "description": "This document provides a step-by-step guide on connecting to seekdb using the MyBatis framework in Java, including prerequisites, configuration of JDBC connection properties, project setup in IntelliJ IDEA, and sample code execution for basic database operations like table creation, data insertion, and querying.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/100.java/700.connect-to-seekdb-through-mysql-connectorJ.md", "description": "This document explains how to connect to seekdb using MySQL Connector/J, including prerequisites, version compatibility, setup instructions, and a complete Java sample program demonstrating database operations via JDBC.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/200.python/100.mysqlclient-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide and sample program for connecting to seekdb using the mysqlclient library in Python, including setup, configuration, and basic database operations like table creation, data insertion, and querying.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/200.python/200.pymysql-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide and sample code for connecting to seekdb using the PyMySQL library in Python, including setup, configuration, and basic database operations like creating tables, inserting data, querying, and cleanup.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/200.python/300.mysql-connector-py-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide on connecting to seekdb using the MySQL-connector-python driver in Python, including prerequisites, connection setup, sample code for database operations, and error handling.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/200.python/400.sqlalchemy-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide on connecting to seekdb using SQLAlchemy in Python, including setup, basic CRUD operations, and error handling.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/200.python/500.django-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide on connecting to seekdb using Django, including setup, configuration, model creation, and basic CRUD operations with error handling tips.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/200.python/600.peewee-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide on connecting to seekdb using the Peewee ORM in Python, including setup, basic CRUD operations, and error handling.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/300.c/100.connect-to-the-seekdb-through-mysql-connector-c.md", "description": "This document provides a step-by-step guide on connecting to seekdb using the MySQL Connector/C (libmysqlclient) in a C application, including prerequisites, installation, code example for basic database operations, and compilation instructions.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/400.go/100.go-sql-driver-mysql-connection-seekdb-sample-program.md", "description": "This document provides a step-by-step guide and sample code for connecting to seekdb using the Go-SQL-Driver/MySQL driver in a Go application, including setup, configuration, and basic database operations.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/400.go/200.gorm-connection-seekdb-example-program.md", "description": "This document provides a step-by-step guide and sample code for connecting to seekdb using GORM in Go, including environment setup, dependency installation, connection configuration, and basic database operations like table creation, data insertion, and querying.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/500.php/100.ext-driver-connects-to-seekdb.md", "description": "This document explains how to use the PHP EXT driver to connect to seekdb, including prerequisites, connection setup, and examples for creating tables and performing basic CRUD operations.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/500.php/200.use-mysqli-driver-to-connect-seekdb.md", "description": "This document explains how to use the PHP MySQLi extension to connect to a seekdb database and perform basic operations like creating a table, inserting data, querying records, and dropping the table. It includes prerequisites, step-by-step instructions, and a complete example script.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/500.php/300.use-pdo-driver-to-connect-seekdb.md", "description": "This document explains how to use the PHP PDO (PHP Data Objects) driver to connect to a seekdb database, including setup prerequisites, connection configuration, and examples for creating tables, inserting data, querying, and cleaning up resources.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/600.rust/100.rust-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide and sample Rust program for connecting to seekdb, demonstrating how to create tables, insert data, and query data using the `mysql` crate.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/600.rust/200.sea-connection-seekdb-program.md", "description": "This document provides a step-by-step guide to building a Rust application using SeaORM and seekdb, covering project setup, database connection, entity definition, CRUD operations, and table creation.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/700.ruby/100.activerecord-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide for connecting to seekdb using Ruby on Rails with ActiveRecord, including setup, configuration, basic CRUD operations, and performance optimization tips.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/700.ruby/200.mysql2-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide and sample Ruby program using the mysql2 gem to connect to SeekDB, demonstrating how to create databases and tables, insert data, and perform queries.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/300.sample-program/700.ruby/300.sequel-connection-to-seekdb-sample-program.md", "description": "This document provides a step-by-step guide to building a Ruby application using the Sequel ORM to connect to seekdb, including setup, configuration, and sample code for creating databases, tables, inserting data, and querying records.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/100.database-connection-pool-configuration.md", "description": "This document explains how to configure database connection pools for SeekDB, covering core parameters, recommended settings, and essential JDBC configuration options to optimize performance, manage resources, and ensure stable database connectivity.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/200.tomcat-connection-pool-configuration-example.md", "description": "This document provides a step-by-step guide to configuring and using the Tomcat connection pool with OceanBase Connector/J and seekdb for basic database operations, including setup in IntelliJ IDEA, connection configuration, and runtime deployment.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/300.c3p0-connection-pool-configuration-example.md", "description": "This document provides a step-by-step guide and sample code for configuring and using the C3P0 connection pool with seekdb and MySQL Connector/J to perform basic database operations such as table creation, data insertion, update, deletion, and query.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/400.proxool-connection-pool-configuration-example.md", "description": "This document provides a step-by-step guide and sample code for configuring and using the Proxool connection pool with seekdb and MySQL Connector/J to perform basic database operations like create, insert, update, delete, and query.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/500.hikaricp-connection-pool-configuration-example.md", "description": "This document provides a step-by-step example of configuring and using the HikariCP connection pool with seekdb and MySQL Connector/J to perform basic database operations such as table creation, data insertion, update, deletion, and query. It includes project setup in Eclipse, connection configuration via `db.properties`, and sample code execution.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/600.dbcp-connection-pool-example.md", "description": "This document provides a step-by-step example of using the Apache DBCP connection pool with MySQL Connector/J and seekdb to perform basic database operations, including setup, configuration, and execution in a Java application.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/700.commonpool-configuration-example.md", "description": "This document provides a step-by-step example of configuring and using Apache Commons Pool with MySQL Connector/J to connect to seekdb, demonstrating basic database operations like create, insert, update, delete, and query through a sample Java project.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/800.druid-connection-pool-configuration-example.md", "description": "This document provides a step-by-step guide and example project for configuring and using the Druid connection pool with MySQL Connector/J to connect to seekdb, including setup instructions, connection string configuration, and sample code for basic database operations.", "branch": "V1.1.0"}
{"path": "200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/900.jdbc-connection-pool-configuration-example.md", "description": "This document provides a JDBC connection configuration example for OceanBase's seekdb, including recommended parameters like `rewriteBatchedStatements`, `allowMultiQueries`, and `useLocalSessionState` to optimize Java application performance and batch operation efficiency.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/10.database-schema-overview.md", "description": "This document provides an overview of database schema design in seekdb, covering databases, table types (including partitioned, columnar, and hybrid row-column tables), update modes (delete_insert and partial_update), and index types (local, unique, full-text, JSON multi-value, spatial, and columnar indexes) to support efficient data modeling and query performance.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/20.create-database-in-develop.md", "description": "This document explains how to create a database in seekdb using SQL, covering prerequisites, naming rules, limitations, best practices for character sets and security, and examples including read-only and read/write databases.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/30.create-table-in-develop.md", "description": "This document explains how to create a table in seekdb using SQL, covering prerequisites, table design considerations, column definitions, primary key setup, and other constraints like `NOT NULL`, `UNIQUE`, `FOREIGN KEY`, and `CHECK`.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/100.json/100.json-formatted-data-types.md", "description": "This document describes the JSON data type in seekdb, including its compliance with RFC 7159, automatic validation, optimized binary storage, and semi-structured encoding for improved compression and performance.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/100.json/200.create-a-json-value.md", "description": "This document explains how to create and manage JSON values in seekdb, including valid JSON syntax, data types, DDL operations for JSON columns, indexing strategies using generated columns, and enabling semi-structured encoding with table-level parameters.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/100.json/300.querying-and-modifying-json-values.md", "description": "This document explains how to query and modify JSON values in seekdb using path expressions, covering operators like `->` and `->>`, JSON functions such as `JSON_EXTRACT`, `JSON_SET`, and `JSON_REMOVE`, and the syntax for navigating hierarchical JSON data with keys, array indices, ranges, and wildcards.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/100.json/400.json-formatted-data-type-conversion.md", "description": "This document explains how to convert between JSON and other data types in seekdb using the CAST function, including conversion rules, character set handling, and practical SQL examples.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/100.json/500.json-partial-update.md", "description": "This document explains how to use seekdb's JSON Partial Update feature to modify specific fields within JSON documents without rewriting the entire value, including configuration via `log_row_value_options`, supported JSON functions (`json_set`, `json_replace`, `json_remove`), storage considerations (`inrow` vs `outrow`), LOB chunk sizing, and update granularity behavior.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/100.json/600.json-semi-struct.md", "description": "This document explains seekdb's semi-structured encoding feature for JSON data, including how to enable it via `SEMISTRUCT_PROPERTIES` and `ROW_FORMAT=COMPRESSED`, configure the `freq_threshold` to define frequent vs. sparse subcolumns, and optimize query performance using `JSON_VALUE()` with extracted structured columns.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/200.spatial/100.spatial-data-type-overview.md", "description": "This document provides an overview of spatial data types supported by seekdb's GIS feature, including fundamental types like POINT, LINESTRING, and POLYGON, their multi-geometry counterparts, and the flexible GEOMETRY and GEOMETRYCOLLECTION types.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/200.spatial/200.spacial-reference-system.md", "description": "This document explains spatial reference systems (SRS) in seekdb, including supported types (projected, geographic, and SRID 0), how to query SRS metadata via `INFORMATION_SCHEMA.ST_SPATIAL_REFERENCE_SYSTEMS`, and the use of WKT-based SRS definitions with SRID requirements for spatial operations.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/200.spatial/300.create-spatial-columns.md", "description": "This document explains how to create and manage spatial columns in seekdb using `CREATE TABLE` and `ALTER TABLE` statements, including syntax examples and constraints related to SRID and spatial indexing.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/200.spatial/400.create-spatial-indexes.md", "description": "This document explains how to create and manage spatial indexes in seekdb, including syntax requirements, constraints (such as NOT NULL and SRID), support for STORED generated columns, and examples using CREATE TABLE, ALTER TABLE, and CREATE INDEX.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/200.spatial/500.spatial-data-format.md", "description": "This document describes the spatial data formats supported by seekdb—Well-Known Text (WKT) and Well-Known Binary (WKB)—including their syntax, structure, and usage for representing geometric objects like points, lines, polygons, and collections in GIS queries.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/300.char-and-text/100.char-and-varchar.md", "description": "This document explains the differences between `CHAR` and `VARCHAR` data types in seekdb, including their storage behavior, maximum lengths, handling of trailing spaces, and syntax with character set and collation options.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/300.char-and-text/200.text.md", "description": "This document describes the `TEXT` data types in SeekDB—`TINYTEXT`, `TEXT`, `MEDIUMTEXT`, and `LONGTEXT`—including their maximum lengths, syntax, character set and collation support, behavior under strict SQL mode, and relationship to `BLOB` types.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/35.multi-model/300.char-and-text/300.full-text-index.md", "description": "This document describes full-text indexing in seekdb, including supported data types, creation constraints, DML operations on indexed tables, and configurable tokenizers like Space, Basic English, Ngram, IK, and Jieba for advanced text search capabilities.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/40.create-index-in-develop.md", "description": "This document explains how to create indexes in seekdb using the `CREATE INDEX` SQL statement, covering prerequisites, limitations (including unique, spatial, and full-text indexes), best practices for index design, and practical examples.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/450.select-vector-index.md", "description": "This document provides guidance on selecting and optimizing dense vector indexes in seekdb, comparing HNSW and IVF index families based on memory usage, performance, data scale, and cost, and includes recommendations for partitioned tables and memory estimation.", "branch": "V1.1.0"}
{"path": "200.develop/200.design-database-schema/50.fork-table.md", "description": "This document describes the `FORK TABLE` feature in seekdb, which creates an isolated, consistent snapshot copy of a source table for use cases like data branching, A/B testing, and synthetic data iteration, while highlighting its limitations and providing a usage example.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/100.write-data/100.insert-data-in-develop.md", "description": "This document explains how to insert data into a table in SeekDB using the `INSERT INTO` statement, covering prerequisites, syntax, single-row and batch inserts, handling of constraints, and methods to avoid uniqueness conflicts such as `INSERT IGNORE` and `ON DUPLICATE KEY UPDATE`.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/100.write-data/200.update-data-in-develop.md", "description": "This document explains how to update data in seekdb using the `UPDATE` statement and alternative methods like `INSERT ... ON DUPLICATE KEY UPDATE`, including syntax, examples, privilege requirements, and handling of unique constraints.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/100.write-data/300.delete-data-in-develop.md", "description": "This document explains how to delete data in SeekDB using the `DELETE` and `TRUNCATE TABLE` statements, including prerequisites, syntax, examples for deleting specific or all records, and performance considerations for large datasets.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/100.write-data/400.replace-data-in-develop.md", "description": "This document explains how to use the `REPLACE INTO` statement in SeekDB to insert or update data based on primary key or unique key conflicts, including syntax, prerequisites, and practical examples.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/100.write-data/500.batch-data-generation-in-develop.md", "description": "This document explains how to generate large volumes of test data in batches for seekdb using three methods: Shell scripts, stored procedures, and ODC (OceanBase Developer Center), covering setup, implementation steps, and execution examples.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/100.single-table-query.md", "description": "This document explains how to perform single-table queries in seekdb using the SQL `SELECT` statement, including syntax, execution order, prerequisites, and examples with test data.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/100.inner-join.md", "description": "This document explains the `INNER JOIN` operation in SeekDB, including its syntax, behavior with and without join conditions, equivalence to comma-separated table queries with `WHERE`, and practical examples demonstrating row matching, Cartesian products, and combined filtering/sorting.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/200.full-join.md", "description": "This document explains the `FULL JOIN` operation in SeekDB, a type of outer join that returns all rows from both tables involved in the join, filling unmatched columns with `NULL`. It includes syntax, examples demonstrating simple and filtered full joins, and links to related join types like `LEFT JOIN`, `RIGHT JOIN`, and `INNER JOIN`.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/300.left-join.md", "description": "This document explains the LEFT JOIN operation in SeekDB, including its syntax, behavior, and practical examples demonstrating how it returns all records from the left table and matching (or NULL-filled) records from the right table, along with usage in simple, complex, and filtered queries.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/400.right-join.md", "description": "This document explains the `RIGHT JOIN` operation in SeekDB, detailing its syntax, behavior as an outer join that returns all rows from the right table and matching rows from the left table (with `NULL`s for non-matches), and providing practical SQL examples including simple joins, complex multi-table joins, and usage with `WHERE` clauses.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/500.subquery.md", "description": "This document explains SQL subqueries in SeekDB, including their types (scalar, column, row, and table subqueries), usage in `SELECT`, `FROM`, `WHERE`, and `HAVING` clauses, supported keywords (`IN`, `ANY`, `SOME`, `ALL`), and practical examples with sample tables.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/600.lateral-derived-tables.md", "description": "This document explains lateral derived tables in SQL, including their syntax, limitations, and use cases, with examples demonstrating how they enable correlated subqueries in the `FROM` clause for efficient multi-table joins and aggregations.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/100.use-arithmetic-operators-in-queries.md", "description": "This document explains how to use arithmetic operators (+, -, *, /, unary -, MOD) in SeekDB SQL queries with practical examples involving numeric columns and calculated fields like total item price.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/1000.lock-query-results-select-for-update.md", "description": "This document explains how to use `SELECT ... FOR UPDATE` in seekdb to lock query results, including the use of `NOWAIT` and `SKIP LOCKED` options to control locking behavior in concurrent transactions.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/1100.query-results-lock-in-share.md", "description": "This document explains the `SELECT ... LOCK IN SHARE MODE` syntax in seekdb, which acquires a shared lock on queried rows to prevent concurrent writes, and notes that seekdb simulates this behavior using write locks—potentially causing read contention—and provides a step-by-step example demonstrating its usage and effects across transactions.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/200.use-numeric-functions-in-queries.md", "description": "This document explains how to use numeric functions such as SUM(), AVG(), ROUND(), CEIL(), and FLOOR() in SQL queries, with a practical example demonstrating their application on a sample `toys_order` table to calculate total and average sales per toy.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/300.use-a-string-connector-in-a-query.md", "description": "This document explains how to use string connectors like `CONCAT()`, `CONCAT_WS()`, and the `||` operator (when enabled via `sql_mode='PIPES_AS_CONCAT'`) to concatenate strings in seekdb queries, with practical examples.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/400.use-string-functions-in-queries.md", "description": "This document explains how to use string functions such as `LENGTH()`, `CHAR_LENGTH()`, `SUBSTR()`, `CONCAT()`, `CONCAT_WS()`, `UPPER()`, `LOWER()`, and `TRIM()` in seekdb SQL queries, with practical examples demonstrating their usage on sample data.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/500.use-time-functions-in-queries.md", "description": "This document explains how to use time functions in seekdb queries, including formatting time values with `DATE_FORMAT`, extracting date/time components using `EXTRACT`, and performing date arithmetic with `DATE_ADD` and `DATE_SUB`. It also lists supported time types and built-in functions like `NOW()`, `CURDATE()`, and `CURTIME()`.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/600.use-type-conversion-functions-in-queries.md", "description": "This document explains how to use type conversion functions like `CONVERT()` and `CAST()` in seekdb queries to convert between data types such as strings, numbers, and time values.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/700.use-aggregate-functions-in-queries.md", "description": "This document explains how to use aggregate functions like `COUNT()`, `SUM()`, `AVG()`, `MIN()`, and `MAX()` in SeekDB queries, including examples with `GROUP BY` and guidance on SQL mode settings such as `ONLY_FULL_GROUP_BY`.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/800.use-null-related-functions-in-queries.md", "description": "This document explains how to handle `NULL` values in SeekDB queries using `NULL`-related functions like `IS NULL`, `NVL()`, and `IFNULL()`, with practical examples demonstrating identification and conversion of `NULL` values.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/300.use-operators-and-functions-in-query/900.use-the-case-function-in-a-query.md", "description": "This document explains how to use the `CASE` function in SeekDB queries, including simple and searched `CASE` clauses, with practical examples for transforming data and implementing conditional logic directly in SQL statements.", "branch": "V1.1.0"}
{"path": "200.develop/300.read-and-write-data/200.read-data/500.query-collection-operations.md", "description": "This document explains how to use collection operators (`UNION`, `UNION ALL`, `INTERSECT`, and `MINUS`/`EXCEPT`) in seekdb to combine, intersect, or subtract result sets from multiple `SELECT` queries, including syntax, behavior, and practical examples.", "branch": "V1.1.0"}
{"path": "200.develop/400.llm/100.model-service-overview.md", "description": "This document provides an overview of seekdb's model service, which enables registration and management of AI models and endpoints for use with AI functions like text generation, embedding, and reranking. It explains core concepts such as AI models, endpoints, model types (LLM, embedding, rerank), and providers (e.g., OpenAI, DeepSeek), and describes how the model service underpins the AI function service in SQL-based intelligent processing.", "branch": "V1.1.0"}
{"path": "200.develop/400.llm/200.model-service-permission.md", "description": "This document explains how to manage AI model permissions in SeekDB, including `CREATE AI MODEL`, `ALTER AI MODEL`, and `DROP AI MODEL` privileges, their distinction from `ACCESS AI MODEL` permissions required for SQL-based AI function calls, and provides syntax and examples for granting, revoking, and verifying these permissions.", "branch": "V1.1.0"}
{"path": "200.develop/400.llm/300.model-register-and-manage.md", "description": "This document explains how to register and manage AI models and endpoints in SeekDB using the `DBMS_AI_SERVICE` system package and provides details on viewing model and endpoint information through dedicated database views.", "branch": "V1.1.0"}
{"path": "200.develop/50.ai-workflow/50.vector-search-workflow.md", "description": "This document outlines the AI application workflow using seekdb vector search, covering vector embedding of unstructured data, storage and indexing in seekdb, hybrid SQL/SDK-based nearest neighbor search, and prompt generation for LLM inference with feedback-driven optimization.", "branch": "V1.1.0"}
{"path": "200.develop/500.vector-embedding/100.vector-embedding-overview.md", "description": "This document provides an overview of vector embedding in seekdb, explaining how unstructured data like text, images, and audio are converted into numerical vectors for semantic similarity search, and describes two methods for generating embeddings: using the built-in AI_EMBED function or external models.", "branch": "V1.1.0"}
{"path": "200.develop/500.vector-embedding/200.ai-embed-function.md", "description": "This document explains how to use the `AI_EMBED` function in seekdb to generate vector embeddings from text using registered AI models, including prerequisites, syntax, parameters, and usage examples.", "branch": "V1.1.0"}
{"path": "200.develop/500.vector-embedding/300.external-embedding-models.md", "description": "This document explains how to use external embedding models—such as Sentence Transformers, Hugging Face Transformers, and Ollama—with seekdb to generate vector embeddings locally or via online services, offering flexibility beyond the built-in AI_EMBED function.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/100.vector-search-intro.md", "description": "This document provides an overview of vector search in seekdb, covering core concepts like vector embeddings, similarity search, and support for dense/sparse vectors, along with details on distance metrics, indexing methods (HNSW, IVF), and SQL-based vector operations.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/120.vector-search-quick-start-sql.md", "description": "This document provides a quick start guide for performing vector search in seekdb using SQL, including creating vector columns and HNSW indexes, inserting vector data, and querying with approximate nearest neighbor search using distance functions like `l2_distance`.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/150.vector-data-type.md", "description": "This document describes the vector data types in seekdb, including syntax and usage for dense and sparse vectors, supported constraints, and examples for creating vector columns and indexes for AI-powered vector search applications.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/160.store-vector-data.md", "description": "This document explains how to store unstructured, semi-structured, and structured data—including vector, spatial, and relational data—in seekdb using the `VECTOR` data type, enabling hybrid search through combined vector and scalar queries.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/100.vector-index-overview.md", "description": "This document provides an overview of vector index types supported by seekdb, including dense indexes (HNSW, HNSW_SQ, HNSW_BQ, IVF, IVF_PQ) and in-memory sparse indexes, along with their characteristics, memory usage, distance algorithms, and limitations.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/200.vector-index-memory-management.md", "description": "This document explains how to estimate, configure, and optimize memory usage for vector indexes in SeekDB, including parameter settings, memory estimation procedures, and memory-saving strategies during index rebuilds.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/300.dense-vector-index/100.dense-vector-index-overview.md", "description": "This document provides an overview of dense vector indexes in SeekDB, including the HNSW and IVF index series, their memory and disk usage characteristics, supported distance functions, and use cases for accelerating nearest neighbor vector searches.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/300.dense-vector-index/200.hnsw-index.md", "description": "This document explains how to create, configure, and perform approximate nearest neighbor (ANN) searches using HNSW, HNSW_SQ, and HNSW_BQ dense vector indexes in SeekDB, including syntax, parameters, performance recommendations, and supported primary key types for accelerated search.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/300.dense-vector-index/300.ivf-index.md", "description": "This document describes the syntax, parameters, and usage examples for creating, searching, and dropping IVF (Inverted File) and IVF_PQ vector indexes in SeekDB, including index creation during or after table creation, ANN search with approximate distance functions, and performance considerations.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/400.sparse-vector-index/100.in-memory-sparse-vector-index.md", "description": "This document explains how to create, manage, and query in-memory sparse vector indexes in SeekDB using the SINDI index from the VSAG library, including support for DDL/DML operations, real-time retrieval, pruning, reranking, and memory estimation for high-performance similarity search on sparse vector data.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/600.vector-index-monitor-and-maintain.md", "description": "This document explains how to monitor and maintain vector indexes in SeekDB, including querying system views for index status, performing incremental or full refreshes using the `DBMS_VECTOR` package, and managing automatic partition rebuilds with configuration options and task controls.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/200.vector-index/700.vector-index-performance-tuning.md", "description": "This document explains how to optimize and monitor vector index performance in seekdb for IVF series indexes, covering automatic cache warming and cleanup tasks, configuration of execution time windows via the `vector_index_optimize_duty_time` parameter, and methods to track or cancel optimization tasks using system views like `DBA_OB_VECTOR_INDEX_TASKS` and `DBA_OB_VECTOR_INDEX_TASK_HISTORY`.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/250.vector-function.md", "description": "This document describes the vector distance functions supported by SeekDB—`L2_distance`, `L2_squared`, `L1_distance`, and `cosine_distance`—including their syntax, usage considerations, input/output behavior, and examples for performing vector similarity searches in SQL.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/300.vector-similarity-search.md", "description": "This document explains vector similarity search in SeekDB, covering both exact nearest neighbor search (via full-table scan) and approximate nearest neighbor search (using HNSW vector indexes), with SQL examples, execution plan analysis, and guidance on when to use each method based on accuracy and performance trade-offs.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/300.vector-search/800.vector-search-faq.md", "description": "This document provides answers to frequently asked questions about vector search in SeekDB, covering topics such as vector dimensionality requirements, scalability limits, and indexing constraints for high-dimensional data.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/400.semantic-search.md", "description": "This document describes how to use seekdb's experimental semantic search feature, which automatically converts raw text into vectors using registered embedding models and supports both synchronous and asynchronous indexing modes with HNSW/HNSW_BQ vector indexes.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/50.full-text-search.md", "description": "This document describes seekdb's full-text search feature, including use cases, index creation rules, supported DML operations, and configurable tokenizers like Space, IK, Ngram, and jieba for efficient text retrieval.", "branch": "V1.0.0"}
{"path": "200.develop/600.search/500.full-text-search.md", "description": "This document describes seekdb's full-text search feature, including use cases, index creation rules, supported DML operations, and configurable tokenizers like Space, IK, Ngram, and jieba for efficient text retrieval.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/500.hybrid-search.md", "description": "This document describes hybrid search in SeekDB, which combines full-text and vector indexing to deliver more accurate and comprehensive search results by integrating semantic and keyword-based matching. It covers usage via the `DBMS_HYBRID_SEARCH` package, supported table types, and provides example tables and queries demonstrating hybrid, full-text, and vector search scenarios.", "branch": "V1.1.0"}
{"path": "200.develop/600.search/600.ai-rerank.md", "description": "This document describes the `AI_RERANK` SQL function in seekdb, which uses a registered AI rerank model to re-sort search results based on semantic relevance between a user query and a list of documents, enhancing result accuracy for RAG applications.", "branch": "V1.1.0"}
{"path": "200.develop/700.ai-function/0.ai-function-overview.md", "description": "This document provides an overview of seekdb's AI Function Service, which enables SQL-based integration of AI capabilities—including text generation (`AI_COMPLETE`, `AI_PROMPT`), embeddings (`AI_EMBED`), and reranking (`AI_RERANK`)—into database workflows, along with required components like permissions management, model registration, and usage prerequisites.", "branch": "V1.1.0"}
{"path": "200.develop/700.ai-function/100.ai-function-permission.md", "description": "This document explains the `ACCESS AI MODEL` permission required to call AI functions such as `AI_COMPLETE`, `AI_EMBED`, `AI_RERANK`, and `AI_PROMPT`, including syntax for granting and revoking the permission and examples of its use.", "branch": "V1.1.0"}
{"path": "200.develop/700.ai-function/200.text-generation-function.md", "description": "This document describes seekdb's text generation AI functions, including `AI_COMPLETE` for invoking large language models via SQL and `AI_PROMPT` for building reusable, parameterized prompt templates to streamline data processing and analysis within the database.", "branch": "V1.1.0"}
{"path": "300.integrations/100.frameworks/100.langchain.md", "description": "This document explains how to integrate seekdb's vector search capabilities with LangChain and the Qwen API for Document Question Answering (DQA), including setup, document ingestion, and similarity search.", "branch": "V1.0.0"}
{"path": "300.integrations/100.frameworks/200.llamaindex.md", "description": "This document explains how to integrate seekdb's vector search capabilities with LlamaIndex and the Qwen API to build a Document Question Answering (DQA) system, including setup, data loading, indexing, and querying.", "branch": "V1.0.0"}
{"path": "300.integrations/100.frameworks/300.springai.md", "description": "This document explains how to integrate seekdb's vector search capabilities with Spring AI Alibaba to enable vector storage, indexing, and similarity search in Java-based AI applications. It includes setup instructions, Maven dependencies, configuration details, and code examples for building features like text similarity search and content recommendation.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/100.jina.md", "description": "This document explains how to integrate Jina AI's embedding models with seekdb for vector storage and semantic search, enabling RAG applications using multimodal embeddings and cosine similarity-based retrieval.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/200.openai.md", "description": "This document explains how to integrate OpenAI's embedding models with seekdb for vector storage and similarity search, including setup, data ingestion, and querying using the OpenAI API and pyseekdb client.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/300.qwen.md", "description": "This document explains how to integrate Alibaba Cloud's Qwen large language model with seekdb for vector storage and similarity search, including setup, data ingestion using Qwen embeddings, and querying via the DashScope API.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/500.huggingface.md", "description": "This document explains how to integrate Hugging Face's embedding models with seekdb for vector storage and semantic search, including setup, data preparation, and querying using the sentence-transformers/all-MiniLM-L6-v2 model.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/600.ollama.md", "description": "This document explains how to integrate Ollama with seekdb to perform vector embedding generation using models like Qwen3-embedding and store/query the resulting vectors in seekdb for semantic search.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/700.google-gemini.md", "description": "This document explains how to integrate Google Gemini's embedding models with seekdb for vector storage and semantic search, including setup, data ingestion, and querying using the text-embedding-004 model.", "branch": "V1.0.0"}
{"path": "300.integrations/200.model-platforms/800.cloudflare-workers-ai.md", "description": "This document explains how to integrate Cloudflare Workers AI with seekdb for vector storage and semantic search, including setup steps, authentication, embedding generation using the bge-base-en-v1.5 model, and performing similarity searches via cosine distance.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/100.cursor.md", "description": "This document explains how to integrate Cursor—an AI-powered code editor—with seekdb using Agent Skills for AI-invokable knowledge packs and workflows, and with the seekdb MCP Server for building backend applications via the Model Context Protocol.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/200.cline.md", "description": "This document explains how to integrate seekdb with Cline, an open-source AI coding assistant that supports the MCP protocol, to build a backend application using seekdb MCP Server and FastAPI. It covers prerequisites, database connection setup, MCP server configuration, and step-by-step instructions for creating and querying a customer table via Cline prompts.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/300.continue.md", "description": "This document explains how to integrate the Continue IDE extension with the seekdb MCP Server using the Model Context Protocol (MCP) to enable LLM-driven SQL execution and rapid backend development with FastAPI.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/400.trae.md", "description": "This document explains how to integrate TRAE—an IDE with MCP Server support—with seekdb Agent Skills for AI-powered knowledge retrieval and workflows, and with the seekdb MCP Server for building backend applications using SQL and external tool interaction.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/600.augment-code.md", "description": "This document explains how to integrate seekdb with Augment Code using the Model Context Protocol (MCP), enabling AI-assisted SQL execution and backend development through a Visual Studio Code plugin.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/700.claude-code.md", "description": "This document explains how to integrate seekdb with Claude Code using Agent Skills and the MCP Server, enabling AI-assisted coding, documentation lookup, data import/export, and SQL execution via Anthropic's terminal-based AI coding assistant.", "branch": "V1.0.0"}
{"path": "300.integrations/300.developer-tools/800.kiro.md", "description": "This document explains how to integrate seekdb with Kiro—an AI-powered IDE from AWS—using the Model Context Protocol (MCP) to build and deploy a FastAPI backend application that interacts with a seekdb database.", "branch": "V1.0.0"}
{"path": "300.integrations/400.workflows/400.dify.md", "description": "This document explains how to integrate seekdb's vector search capabilities with Dify, an open-source LLM application development platform, by configuring Dify to use seekdb as its vector store via Docker deployment and MySQL-compatible connection settings.", "branch": "V1.0.0"}
{"path": "300.integrations/400.workflows/500.n8n.md", "description": "This document explains how to integrate seekdb with n8n to build an AI-powered \"Chat to seekdb\" workflow using n8n's automation capabilities, Ollama-hosted Qwen3 model, and MySQL database tools.", "branch": "V1.0.0"}
{"path": "300.integrations/500.data-analyst/100.camel.md", "description": "This document explains how to integrate CamelAI with seekdb for natural language querying and semantic search, including setup, data embedding using Jina AI, vector storage in seekdb, and performing similarity-based retrieval.", "branch": "V1.0.0"}
{"path": "300.integrations/600.mcp/100.toolbox.md", "description": "This document explains how to build a seekdb MCP (Model Context Protocol) server using the Google GenAI Toolbox, enabling LLMs to interact with seekdb databases via predefined SQL tools without writing code. It covers setup, configuration, testing with MCP Inspector, and integration with MCP-compatible clients like Continue, Claude Desktop, and Cline.", "branch": "V1.0.0"}
{"path": "300.integrations/600.mcp/200.seekdb-mcp-server.md", "description": "This document describes the seekdb MCP server, which implements Anthropic's Model Context Protocol (MCP) to enable AI assistants to interact with a seekdb database using natural language. It covers core capabilities like vector collection management, hybrid search, AI functions, persistent memory, and data import/export, along with installation, configuration, and use cases such as knowledge base creation, RAG prototyping, and AI coding assistant enhancement.", "branch": "V1.0.0"}
{"path": "300.integrations/700.others/100.firecrawl.md", "description": "This document explains how to integrate Firecrawl with seekdb to build a Retrieval-Augmented Generation (RAG) pipeline, using Firecrawl for web scraping, Jina AI for embeddings, and seekdb for vector storage and semantic search.", "branch": "V1.0.0"}
{"path": "400.guides/1000.obshell/100.obshell-overview.md", "description": "This document provides an overview of OceanBase Shell (obshell), a no-installation command-line tool for managing OceanBase seekdb and cluster deployments, enabling unified database operations and simplified third-party integration.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/1000.error.md", "description": "This document lists obshell error codes, their meanings, and troubleshooting solutions, helping users diagnose and resolve issues during obshell operations or when using the obshell Dashboard.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/300.obshell-clients/100.agent-commands.md", "description": "This document describes the `obshell agent` commands for managing obshell in seekdb environments, including start, stop, restart, and upgrade operations with options for port configuration, IPv6 support, base directory specification, and root password handling.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/300.obshell-clients/200.seekdb-commands.md", "description": "This document provides reference for `obshell seekdb` commands used to manage a seekdb instance, including start, restart, stop, and show operations with their respective options and usage examples.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/300.obshell-clients/300.utilities-commands.md", "description": "This document describes the `obshell task` commands for managing SeekDB tasks, including show, cancel, rollback, retry, pass, and watch operations, with details on options like task ID, port, IPv6 support, and confirmation skipping.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/100.dashboard-overview.md", "description": "This document provides an overview of the obshell Dashboard, a web-based visual management interface for seekdb that offers resource management, performance monitoring, instance/database/user administration, alarm handling, parameter configuration, package upgrades, and task tracking—all integrated into the obshell process for simplified OceanBase operations.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/200.dashboard-instance.md", "description": "This document describes the **Instance Management** page in the obshell Dashboard, covering instance status, basic information, start/stop/restart operations, obshell upgrades, IP whitelist configuration, and major compaction management for seekdb instances.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/300.dashboard-db.md", "description": "This document describes how to manage databases in the obshell Dashboard, including viewing database details, creating, editing, and deleting databases, as well as copying JDBC connection strings and searching or sorting database entries.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/400.dashboard-user.md", "description": "This document explains how to manage users in the obshell Dashboard, including creating, locking, unlocking, deleting users, changing passwords, and modifying global and database-level permissions.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/500.dashboard-alarm.md", "description": "This document describes how to manage alerts in the obshell Dashboard's Alarm Center, including viewing alarm events, setting suppression rules, and configuring alert rules to ensure system stability.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/600.dashboard-monitor.md", "description": "This document describes how to use the **Performance monitoring** feature in the obshell Dashboard to monitor key metrics for seekdb, including Performance and SQL, Transaction, Storage and Cache, and Host performance, with guidance on customizing refresh frequency, time range, and interacting with monitoring charts.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/700.dashboard-parameter.md", "description": "This document explains how to view and modify seekdb instance parameters using the obshell Dashboard's Parameter Management page, including searching for parameters and updating their values.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/800.dashboard-package.md", "description": "This document explains how to manage software packages in the obshell Dashboard, including viewing package details (name, version, architecture, MD5, etc.), uploading RPM packages, and uninstalling packages via the web console.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/350.obshell-dashboard/900.ob-dashboard-task.md", "description": "This document describes how to manage tasks in the obshell Dashboard's Mission Center, including viewing, filtering, and performing actions such as canceling, retrying, rolling back, or skipping tasks based on their status.", "branch": "V1.1.0"}
{"path": "400.guides/1000.obshell/900.configure-monitor.md", "description": "This document explains how to configure monitoring for obshell Dashboard by deploying and setting up obagent, Prometheus, and Alertmanager to collect, store, and alert on seekdb performance metrics.", "branch": "V1.1.0"}
{"path": "400.guides/1050.data-load-and-dump/400.load-data.md", "description": "This document explains how to import data into seekdb using server-side and client-side methods, focusing on the recommended server-side approach with `LOAD DATA FROM FILES()` and `INSERT INTO ... SELECT FROM FILES()`, including setup, permissions, examples, and error handling.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/100.ob-vector-search-bench-test.md", "description": "This document provides a step-by-step guide for benchmarking seekdb's vector search performance using VectorDBBench, including prerequisites, test setup with HNSW index on the Performance1536D50K dataset, and instructions for running and interpreting QPS, latency, and recall metrics.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/200.vectobench-benchmark-report-of-seekdb.md", "description": "This document presents the VectorDBBench benchmark report for seekdb, detailing test environments (1C2G and 4C8G ECS instances), test plan using Performance1536D50K dataset with HNSW index, and performance results including QPS, p99 latency, and recall rate at 0.98.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/200.sysbench-test-on-seekdb/100.use-sysbench-to-test-the-performance-of-seekdb.md", "description": "This document explains how to use Sysbench—a LuaJIT-based, multi-threaded benchmarking tool—to evaluate the database performance of seekdb, including environment setup, parameter optimization, test data preparation, and execution of various OLTP workloads like point_select, read_write, and insert.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/200.sysbench-test-on-seekdb/200.sysbench-benchmark-report-of-seekdb.md", "description": "This document presents a Sysbench benchmark report for seekdb, detailing test environments (1C2G and 4C8G instances), methodology, and performance metrics—including TPS and 99th percentile latency—for workloads like point_select, read_write, insert, and update under varying thread counts.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/300.tpc-h-test-on-seekdb/100.use-tpc-h-to-test-the-performance-of-seekdb.md", "description": "This document provides a step-by-step guide to running the TPC-H benchmark test on seekdb using the official TPC-H tools, including environment setup, configuration tuning, data generation, and query execution for performance evaluation.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/300.tpc-h-test-on-seekdb/200.tpc-h-benchmark-report-of-seekdb.md", "description": "This document provides a detailed TPC-H benchmark report for seekdb, including the test plan, environment setup on Alibaba Cloud ECS (4 vCPUs, 8 GB memory), and performance results for a 10 GB dataset with 4-query concurrency.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/400.mldr-test-on-seekdb/100.mldr-test-of-seekdb.md", "description": "This document provides a step-by-step guide to benchmarking seekdb using the MLDR (Multi-Lingual Document Retrieval) framework, covering setup, configuration, and execution for evaluating retrieval quality (Recall@10, NDCG@10) and latency across BM25, dense vector, and hybrid query types.", "branch": "V1.1.0"}
{"path": "400.guides/1100.performance-test/400.mldr-test-on-seekdb/200.mldr-benchmark-report-of-seekdb.md", "description": "This document presents the MLDR benchmark report for seekdb, detailing the test plan, environment (Alibaba Cloud ECS 4C8G), and performance results—including NDCG@10, recall@10, and response time—using a 200k-record dataset with dense+BM25 retrieval.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/100.prepare-servers.md", "description": "This document outlines the hardware and software requirements for preparing servers to deploy seekdb, including minimum server specifications, supported operating systems, memory and disk configuration, BIOS settings, and commands to verify system compatibility.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/50.deploy-overview.md", "description": "This document provides an overview of seekdb's two deployment modes—Embedded mode for endpoint applications (mobile, desktop, IoT) and Server mode for CI/CD/testing—with details on available deployment methods including SDK, package managers, Docker, and OceanBase Desktop.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/500.environment-and-configuration-checks/100.configurations-overview.md", "description": "This document provides an overview of essential pre-deployment configuration steps for seekdb, including user setup, disk planning, and system-level optimizations (limits.conf, sysctl.conf), as well as firewall and SELinux settings, with distinctions between personal trial and production environment requirements.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/500.environment-and-configuration-checks/300.create-regular-user.md", "description": "This document explains how to create a regular user with sudo privileges for deploying SeekDB in enterprise environments, including setting up the user account, home directory ownership, and password configuration.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/500.environment-and-configuration-checks/400.plan-disks.md", "description": "This document provides guidance on planning and configuring disks for seekdb deployments, including recommendations for separating data, transaction log, and installation disks in enterprise environments, along with detailed instructions for mounting disks using LVM or fdisk and verifying disk setup.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/500.environment-and-configuration-checks/500.configure-limits-conf.md", "description": "This document explains how to configure system resource limits for seekdb by editing `/etc/security/limits.conf`, including settings for open files, stack size, core file size, and user processes, with instructions for verification using `ulimit -a`.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/500.environment-and-configuration-checks/600.configure-sysctl-conf.md", "description": "This document explains how to optimize Linux system performance for SeekDB by configuring kernel parameters in `/etc/sysctl.conf`, including settings for asynchronous I/O, network tuning, virtual memory, and core dump handling, with additional recommendations for ARM and Hygon architectures.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/500.environment-and-configuration-checks/700.disable-firewall-and-selinux.md", "description": "This document provides instructions for disabling the firewall and SELinux on a system, including commands to stop and disable firewalld and to configure SELinux in disabled mode, primarily intended for enterprise deployment environments.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/600.python-seekdb.md", "description": "This document describes how to deploy seekdb in embedded mode using Python or the pyseekdb SDK, including environment requirements (Linux with glibc ≥ 2.28, Python 3.8–3.14, x86_64/aarch64), installation via pip, and compatibility details for mobile, desktop, IoT, and edge applications.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/700.server-mode/100.deploy-by-systemd.md", "description": "This document explains how to deploy seekdb using systemd with system package managers (RPM for CentOS/RHEL/Anolis/openEuler and DEB for Debian/Ubuntu), covering prerequisites, installation (online/offline), configuration, service management, and removal.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/700.server-mode/200.deploy-by-docker.md", "description": "This document explains how to deploy seekdb using Docker, including pulling the image from container registries, starting a container with customizable environment variables or configuration files, persisting data, connecting via MySQL client, and accessing the obshell dashboard.", "branch": "V1.1.0"}
{"path": "400.guides/400.deploy/700.server-mode/300.deploy-oceanbase-desktop.md", "description": "This document provides step-by-step instructions for deploying OceanBase Desktop on Windows (using WSL 2) and macOS, including system requirements, installation steps, and connection examples for managing seekdb databases via a graphical interface.", "branch": "V1.1.0"}
{"path": "400.guides/460.upgrade/100.upgrading-via-mysqldump.md", "description": "This document explains how to upgrade seekdb using mysqldump for logical migration, including prerequisites, step-by-step backup and restore instructions, parameter details, example commands, and troubleshooting for common issues like query timeouts.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/100.configuration-management-introduction.md", "description": "This document introduces seekdb's configuration management system, explaining the differences between system configuration items (instance-scoped, modifiable via SQL or startup parameters) and system variables (session- or global-level, SQL-modifiable only), including their scope, modification methods, lifecycle, and query techniques.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/200.system-configuration-items/100.configuration-items-overview.md", "description": "This document provides an overview of seekdb configuration items, including data types, visibility rules (e.g., hidden items prefixed with an underscore), and how to determine whether a parameter takes effect dynamically or requires a restart. It also explains how to view configuration parameters using the `SHOW PARAMETERS` SQL command.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/200.system-configuration-items/200.view-parameters.md", "description": "This document explains how to view system configuration parameters in SeekDB using the `SHOW PARAMETERS` statement or by querying the `GV$OB_PARAMETERS` view, including details on parameter attributes, data types, edit levels, and default values.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/200.system-configuration-items/300.modify-parameters.md", "description": "This document explains how to modify SeekDB system parameters, including dynamic and restart-effective types, using the `ALTER SYSTEM SET` command with scope options (`SPFILE` or `BOTH`), and how to verify changes using `SHOW PARAMETERS`.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/200.system-configuration-items/400.reset-parameters.md", "description": "This document explains how to reset system configuration parameters to their default values in SeekDB using the `ALTER SYSTEM RESET` statement, including syntax, scope options (`SPFILE` or `BOTH`), and verification steps.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/300.system-variable/100.system-variable-overview.md", "description": "This document provides an overview of seekdb system variables, explaining the differences between global and session variables, their scope, modification methods, and how they differ from system parameters.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/300.system-variable/200.view-system-variables.md", "description": "This document explains how to view system variables in SeekDB using `SHOW` statements or by querying system views such as `INFORMATION_SCHEMA.SESSION_VARIABLES`, `INFORMATION_SCHEMA.GLOBAL_VARIABLES`, and `oceanbase.DBA_OB_SYS_VARIABLES`. It includes examples for checking session and global variable values, modification status, and default settings.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/100.configuration-management/300.system-variable/300.modify-system-variables.md", "description": "This document explains how to modify session-level and global-level system variables in SeekDB using the `SET` statement, including examples for numeric and boolean variables like `ob_query_timeout` and `foreign_key_checks`, along with verification steps and related views such as `DBA_OB_SYS_VARIABLES`.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/200.high-availability/200.recyclebin/100.recyclebin-overview.md", "description": "This document provides an overview of the recycle bin feature in SeekDB, which stores deleted databases, tables, and indexes, allowing for recovery via flashback or permanent removal via purge, along with its supported objects, limitations, and related operations.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/200.high-availability/200.recyclebin/200.turn-the-recyclebin-on-or-off.md", "description": "This document explains how to enable or disable the recycle bin in seekdb using global or session-level system variables, including commands to check the current status and apply changes.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/200.high-availability/200.recyclebin/300.view-the-recyclebin-objects.md", "description": "This document explains how to view objects in the SeekDB recycle bin using the `SHOW RECYCLEBIN` statement, including field descriptions and prerequisites for accessing recycled databases, tables, or indexes.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/200.high-availability/200.recyclebin/400.restore-the-recyclebin-objects.md", "description": "This document explains how to restore deleted databases and tables from the seekdb recycle bin using the `FLASHBACK` statement, including syntax for restoring with original or new names and considerations for dependencies like indexes and parent databases.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/200.high-availability/200.recyclebin/500.purge-the-recyclebin.md", "description": "This document explains how to manually and automatically purge objects from the seekdb recycle bin using the `PURGE` command or by configuring the `recyclebin_object_expire_time` parameter, including considerations, procedures, and examples for purging databases, tables, indexes, or all recycle bin contents.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/200.high-availability/600.flashback-query.md", "description": "This document explains how to configure and perform flashback queries in seekdb using the `AS OF SNAPSHOT` syntax and the `undo_retention` parameter, including prerequisites, usage examples, and important considerations such as DDL impacts and storage requirements.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/100.security-overview.md", "description": "This document provides an overview of SeekDB's enterprise-grade security features, including identity authentication, access control, and data transmission encryption, designed to protect database files and user data from unauthorized access.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/200.identification-and-authentication/100.identification.md", "description": "This document explains user identification in seekdb, covering how user identity is verified using the MySQL Authentication Protocol (MAPI), the role of username-host combinations in defining users, and how client IP addresses and passwords control access to the database.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/200.identification-and-authentication/200.password-complexity.md", "description": "This document explains how to configure password complexity rules in seekdb using system variables to enforce strong password policies, including requirements for length, character types, and username comparison, thereby enhancing database security against brute-force and credential-based attacks.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/200.identification-and-authentication/300.login-failure-handling.md", "description": "This document explains how seekdb handles login failures by locking user accounts after a configurable number of failed attempts, using parameters like `connection_control_failed_connections_threshold`, `connection_control_min_connection_delay`, and `connection_control_max_connection_delay` to enforce security policies and prevent brute-force attacks.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/100.access-control-overview.md", "description": "This document provides an overview of seekdb's access control mechanisms, covering permission management through user and role verification strategies, as well as network security via client allowlists.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/100.permission-classification.md", "description": "This document describes the three levels of permission types in SeekDB—global, database, and object privileges—and lists the specific privileges available at each level, including their descriptions and associated SQL operations.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/110.create-user.md", "description": "This document explains how to create a user in SeekDB, including required privileges, username rules, and the `CREATE USER` SQL syntax with examples for minimal privilege setup.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/200.direct-authority.md", "description": "This document explains how to directly grant privileges to users in SeekDB using the `GRANT` statement, covering syntax, privilege levels (global, database, table, column), prerequisites like `GRANT OPTION`, user creation behavior, and practical examples for various access control scenarios.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/300.delegation-of-authority.md", "description": "This document explains how to use the `WITH GRANT OPTION` clause in SeekDB to delegate user privileges, enabling authorized users to grant their permissions to others, and highlights the difference between successful and failed delegation scenarios.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/100.roles-overview.md", "description": "This document provides an overview of role management in seekdb, explaining how roles—combinations of permissions—can be assigned to users and other roles to simplify access control.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/200.create-a-role.md", "description": "This document explains how to create a role in SeekDB using the `CREATE ROLE` statement, including prerequisites such as required privileges and read-only mode considerations, syntax examples with and without `IF NOT EXISTS`, and next steps for granting privileges or roles.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/300.grant-privileges-to-a-role.md", "description": "This document explains how to grant privileges to a role in SeekDB, including prerequisites, required permissions like `GRANT OPTION`, and examples for granting system, database, table, and column-level privileges using the `GRANT` statement.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/400.grant-a-role-to-a-role-or-user.md", "description": "This document explains how to grant a role to users or other roles in SeekDB, including syntax examples, prerequisites like the `ADMIN OPTION` privilege, and guidance on activating granted roles.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/500.activate-roles.md", "description": "This document explains how to activate roles in seekdb, including setting default roles at login using `SET DEFAULT ROLE` or `ALTER USER`, enabling automatic role activation via the `activate_all_roles_on_login` global variable, and managing active roles in a session with the `SET ROLE` statement.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/600.view-roles.md", "description": "This document explains how to view roles and their associated privileges in SeekDB (OceanBase), including checking user grants, role hierarchies, default login roles, currently active session roles, and detailed table- or column-level permissions using system views like `mysql.default_roles`, `mysql.role_edges`, and `information_schema.role_table_grants`.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/700.revoke-privileges-from-a-role.md", "description": "This document explains how to revoke privileges from a role in SeekDB, including prerequisites, syntax examples for revoking system, database, table, and column-level permissions, and references to the REVOKE statement documentation.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/800.revoke-a-role-from-a-user-or-role.md", "description": "This document explains how to use the `REVOKE` statement to remove a role from a user or another role in SeekDB, including syntax examples, prerequisites (such as requiring the `ADMIN OPTION` privilege), and considerations like the delayed effect on currently logged-in users. It also covers optional clauses like `IGNORE UNKNOWN USER` and `IF EXISTS` for handling missing users or roles during revocation.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/340.role-management/900.delete-a-role.md", "description": "This document explains how to delete a role in SeekDB using the `DROP ROLE` statement, including prerequisites, considerations, and examples.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/350.indirect-authority.md", "description": "This document explains how users gain indirect privileges through role assignments in SeekDB, including prerequisites, activation requirements, and examples of granting roles to users or other roles.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/400.view-user-permissions.md", "description": "This document explains how to view user permissions in SeekDB using the `SHOW GRANTS` statement or by querying system views such as `mysql.user`, `mysql.db`, `mysql.columns_priv`, and `information_schema.COLUMN_PRIVILEGES`, including prerequisites and examples for each method.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/50.user-and-permission-overview.md", "description": "This document provides an overview of user and permission management in SeekDB, covering user roles, permission levels (global, database, object), permission delegation, role-based access control, indirect permissions, and permission validation during SQL execution.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/500.modify-user-permissions.md", "description": "This document explains how to revoke user privileges in SeekDB, including prerequisites, syntax for global/database/table/column-level revocation, and important considerations like non-cascading behavior.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/700.lock-and-unlock-users.md", "description": "This document explains how administrators can lock or unlock user accounts in seekdb using the `ALTER USER ... ACCOUNT LOCK | UNLOCK` statement, including prerequisites, step-by-step procedures, and verification via the `DBA_OB_USERS` view.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/200.user-and-permission/800.delete-a-user.md", "description": "This document explains how to delete a user in SeekDB using the `DROP USER` SQL statement, including prerequisites, limitations, and step-by-step instructions.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/300.access-control/300.network-security-access-control.md", "description": "This document explains how to configure network security access control in seekdb using the `ob_tcp_invited_nodes` global variable, which supports exact IP matches, wildcard patterns (%, _), and CIDR/netmask notation to define client IP whitelists.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/400.data-transfer-encryption/100.data-transfer-encryption-overview.md", "description": "This document provides an overview of data transfer encryption in seekdb, detailing its support for SSL/TLS protocols to secure MySQL and OB-RPC communications, and describing available authentication mechanisms including one-way SSL, X.509 two-way authentication, and composable two-way authentication options.", "branch": "V1.1.0"}
{"path": "400.guides/500.manage/300.security/400.data-transfer-encryption/200.seekdb-transmission-encryption.md", "description": "This document explains how to enable and verify transmission encryption for seekdb using SSL/TLS, covering configuration steps for MySQL and RPC ports, certificate management via the `wallet` folder, and methods to confirm encryption is active.", "branch": "V1.1.0"}
{"path": "450.reference/100.mysql-compatibility/100.mysql-compatibility.md", "description": "This document outlines the compatibility between seekdb and MySQL 5.7/8.0, covering supported and unsupported features across data types, SQL syntax, procedural language (PL) elements, system views, character sets, collations, functions, partitioning, storage engines, and query optimization.", "branch": "V1.1.0"}
{"path": "450.reference/1300.release-notes/1000.v1.0.0.md", "description": "This document outlines the features, architecture, and use cases of OceanBase seekdb v1.0.0, an AI-native multimodal database supporting hybrid search (vector, full-text, relational, JSON, GIS), in-database AI inference, and seamless integration with AI frameworks like LangChain and LlamaIndex.", "branch": "V1.0.0"}
{"path": "450.reference/1300.release-notes/998.V1.1.0.md", "description": "This document outlines the V1.1.0 release of seekdb, highlighting new features like macOS build support and the experimental `FORK TABLE` command for efficient table cloning, along with storage optimizations, memory management improvements, configuration changes, and bug fixes for vector and semantic indexes.", "branch": "V1.0.0"}
{"path": "450.reference/1300.release-notes/999.V1.0.1.md", "description": "This document outlines the release notes for SeekDB version V1.0.1, including new vector index enhancements (support for IP and cosine distance metrics in `hnsw_bq`, increased `ef_search` limit), bug fixes across vector indexes, semantic indexes, full-text search, and other core components, as well as upgrade guidance from V1.0.0.", "branch": "V1.0.0"}
{"path": "450.reference/1600.seekdb-docs-catalog.md", "description": "This document serves as a searchable catalog of all seekdb documentation, providing descriptions and relative file paths for guides covering setup, SQL and SDK usage, AI coding integrations, hybrid/vector search, and connection methods with frameworks like Spring Boot, MyBatis, and PyMySQL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/100.data-type-overview.md", "description": "This document provides an overview of all data types supported by seekdb, including numeric, date/time, string, large object, text, enumeration, set, JSON, spatial, bitmap, array, and map types, along with their properties, storage requirements, and comparison behavior.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1000.roaring-bitmap-data-type/100.roaring-bitmap-data-type-overview.md", "description": "This document provides an overview of the RoaringBitmap data type in seekdb, highlighting its efficiency for storing and processing sets of unsigned integers, with benefits including high space efficiency, fast bitwise operations, and superior performance for sparse bit arrays compared to traditional bitmaps.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1000.roaring-bitmap-data-type/200.create-roaring-bitmap-columns.md", "description": "This document explains how to create and manage roaring bitmap columns in seekdb using `CREATE TABLE` and `ALTER TABLE` statements, including syntax examples for defining, modifying, inserting, and querying roaring bitmap data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1200.array-data-type/100.array-data-type-overview.md", "description": "This document provides an overview of the ARRAY data type in seekdb, including supported element types (integer, floating-point, and VARCHAR), common use cases in OLAP scenarios for representing multivalued attributes, and current limitations such as the lack of default value support.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1200.array-data-type/200.create-array-columns.md", "description": "This document explains how to create array columns in SeekDB using the `CREATE TABLE` statement, including syntax examples, supported data types, nesting up to six levels, and considerations such as the inability to set default values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1300.map-data-type/100.map-data-type-overview.md", "description": "This document provides an overview of the map data type in seekdb, including its structure, supported key and value types, usage scenarios, available expressions like `map_keys` and `map_values`, and current limitations such as unsupported comparison and aggregation operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/1300.map-data-type/200.create-map-columns.md", "description": "This document explains how to create map columns in SeekDB using the `CREATE TABLE` statement, including syntax, nesting limits (up to six levels), supported key-value types, and examples of defining, inserting, and querying map data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/100.numeric-type.md", "description": "This document describes the numeric data types supported in seekdb, including integer types (e.g., `TINYINT`, `INTEGER`, `BIGINT`), fixed-point types (`DECIMAL`, `NUMERIC`), floating-point types (`FLOAT`, `DOUBLE`), and the `BIT` type, along with details on precision, scale, and the `ZEROFILL` attribute.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/200.integer-type.md", "description": "This document describes the integer data types supported by SeekDB, including `TINYINT`, `SMALLINT`, `MEDIUMINT`, `INT`, `BIGINT`, and `SERIAL`, along with their storage sizes, signed/unsigned value ranges, syntax options like `ZEROFILL` and `UNSIGNED`, and usage notes—particularly for `BIGINT` arithmetic and `SERIAL` as an auto-incrementing primary key type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/300.fixed-point-type.md", "description": "This document describes fixed-point numeric data types in seekdb, including DECIMAL, NUMERIC, and FIXED, their syntax with precision (M) and scale (D), supported attributes like UNSIGNED and ZEROFILL, value ranges, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/400.floating-point-type.md", "description": "This document describes the floating-point numeric data types (`FLOAT`, `DOUBLE`, and `DOUBLE PRECISION`) in seekdb, including their syntax, storage characteristics, precision, scale, value ranges, and usage recommendations. It also covers optional attributes like `UNSIGNED` and `ZEROFILL`, and notes on deprecated syntax and limitations regarding special values such as `NaN` and infinity.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/500.bit-value-type.md", "description": "This document describes the `BIT` data type in SQL, including its syntax `BIT[(M)]`, valid bit-value literals (e.g., `b'101'`), and how values are padded to match the specified bit length `M` (ranging from 1 to 64).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/100.date-and-time-types.md", "description": "This document describes the date and time data types supported in seekdb—`DATE`, `TIME`, `DATETIME`, `TIMESTAMP`, and `YEAR`—including their formats, valid ranges, zero values, and scale-dependent precision for fractional seconds.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/200.date-datetime-and-timestamp-types.md", "description": "This document describes the `DATE`, `DATETIME`, and `TIMESTAMP` data types in seekdb, including their syntax, supported ranges, fractional second precision, automatic initialization features, and time zone handling for `TIMESTAMP`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/300.time-type.md", "description": "This document describes the `TIME` data type in seekdb, including its supported range, format for storage and display (with optional fractional seconds precision up to microseconds), and syntax with fractional second precision (`fsp`) specification.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/400.year-type.md", "description": "This document describes the `YEAR` data type in seekdb, including its supported value formats, valid range (1901–2155 and 0000), and how 1- or 2-digit inputs are interpreted as years in the 20th or 21st century.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/400.string/100.string-type-overview.md", "description": "This document provides an overview of string data types in seekdb, including `CHAR`, `VARCHAR`, `BINARY`, and `VARBINARY`, detailing their length types, maximum lengths, and character sets.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/400.string/200.char-and-varchar-of-syntax.md", "description": "This document describes the syntax, storage behavior, and differences between `CHAR` and `VARCHAR` string data types in seekdb, including their maximum lengths, handling of trailing spaces, character set and collation support, and binary variants.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/400.string/300.binary-and-varbinary.md", "description": "This document describes the `BINARY` and `VARBINARY` data types in SeekDB, which store binary byte strings with fixed and variable lengths, respectively, using binary character set and collation.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/100.large-object-and-text-type-overview.md", "description": "This document provides an overview of seekdb's large object and text data types (`BLOB`, `TEXT`, and `STRING`), including their storage limits, character sets, and key differences from `VARBINARY` and `VARCHAR` types, such as indexing requirements and lack of default value support.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/200.blob-type.md", "description": "This document describes the `BLOB` data type in SeekDB, including its variants (`TINYBLOB`, `BLOB`, `MEDIUMBLOB`, and `LONGBLOB`), their maximum storage capacities, binary string handling, and behavior under strict and non-strict SQL modes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/300.text-type.md", "description": "This document describes the `TEXT` data type in seekdb, including its variants (`TINYTEXT`, `TEXT`, `MEDIUMTEXT`, and `LONGTEXT`), their maximum lengths, storage characteristics, character set and collation support, and behavior under strict and non-strict SQL modes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/350.string-type.md", "description": "This document describes the `STRING` data type in OceanBase Database, a variable-length text type supporting up to 16 MB of storage, usable as a primary key, index, or partitioning key, with specific behaviors and limitations related to LOB storage, in-row thresholds, and indexing constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/400.lob-type.md", "description": "This document describes LOB (Large Object) data types in OceanBase Database, including supported types (e.g., BLOB, TEXT, JSON, GEOMETRY), inline (INROW) and out-of-line (OUTROW) storage mechanisms, and the configurable `LOB_INROW_THRESHOLD` parameter that determines storage behavior based on data size.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/600.enum-type.md", "description": "This document describes the `ENUM` data type in SQL, including its syntax, internal integer representation, storage benefits, and support for character sets like `UTF8MB4`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/700.set-type.md", "description": "This document describes the `SET` data type in seekdb, a string object that stores zero or more predefined values from a specified list, supports UTF8MB4 character set, and is internally represented as integers with up to 64 elements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/800.json-formatted-data-type/100.json-formatted-data-types-of-syntax.md", "description": "This document describes seekdb's JSON data types, which conform to RFC 7159, support automatic validation, efficient binary storage, and semi-structured encoding for reduced storage costs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/800.json-formatted-data-type/200.create-a-json-value-of-syntax.md", "description": "This document describes the syntax and rules for creating JSON values in seekdb, including supported data types (objects, arrays, strings, numbers, booleans, null), structural requirements, encoding considerations, and DDL operations such as creating tables with JSON columns, adding indexes on generated columns, and enabling semi-structured encoding.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/800.json-formatted-data-type/300.querying-and-modifying-json-values-of-syntax.md", "description": "This document describes how to query and modify JSON values in seekdb using path expressions, covering operators like `->` and `->>`, JSON functions such as `JSON_EXTRACT`, `JSON_SET`, and `JSON_REMOVE`, and the syntax for specifying paths with keys, array indices, ranges, and wildcards.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/800.json-formatted-data-type/400.json-formatted-data-type-conversion-of-syntax.md", "description": "This document describes how to use the CAST function in seekdb to convert between JSON and other data types, including character sets, scalar values, and NULL, with syntax rules and examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/800.json-formatted-data-type/500.json-partial-update-of-syntax.md", "description": "This document describes how to perform partial updates on JSON documents in seekdb using specific JSON functions (`json_set`, `json_replace`, `json_remove`), including enabling the feature via the `log_row_value_options` system variable, storage format requirements (`outrow`), LOB block size considerations, and update granularity behavior.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/900.spatial-data-type/100.spatial-data-type-overview-of-syntax.md", "description": "This document provides an overview of spatial data types supported by seekdb's GIS feature, including GEOMETRY, POINT, LINESTRING, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, and GEOMETRYCOLLECTION, along with their hierarchical relationships and usage for storing single or collection-based spatial data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/900.spatial-data-type/200.spacial-reference-system-of-syntax.md", "description": "This document describes spatial reference systems (SRS) in seekdb, including projected and geographic SRS types, the default SRID 0, and how to query SRS metadata using the `INFORMATION_SCHEMA.ST_SPATIAL_REFERENCE_SYSTEMS` table.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/900.spatial-data-type/300.create-spatial-columns-of-syntax.md", "description": "This document describes the syntax and constraints for creating spatial columns in SeekDB using `CREATE TABLE` or `ALTER TABLE`, including SRID specification, spatial indexing requirements, and data consistency rules.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/900.spatial-data-type/400.create-spatial-indexes-of-syntax.md", "description": "This document explains how to create and manage spatial indexes in seekdb, including syntax requirements, prerequisites like SRID configuration, and examples for tables and stored generated columns.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/900.spatial-data-type/500.spatial-data-format-of-syntax.md", "description": "This document describes the spatial data formats supported by seekdb—Well-Known Text (WKT) and Well-Known Binary (WKB)—including their syntax, structure, and usage in SQL queries for representing geometric objects like Point, LineString, Polygon, and their multi-geometry and collection variants.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/200.expression/100.expression-overview.md", "description": "This document provides an overview of SQL expressions in SeekDB, explaining their structure, input sources (such as column references, constants, operators, and functions), and usage contexts within SQL statements like SELECT, WHERE, ORDER BY, and SET clauses.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/200.expression/200.expression-syntax.md", "description": "This document defines the syntax rules for expressions in seekdb SQL, including logical, comparison, bitwise, and predicate operations, along with operator precedence references.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/200.expression/300.type-conversion-of-expression-evaluation.md", "description": "This document explains seekdb's data type conversion rules during expression evaluation, covering implicit and explicit conversions (via `CAST`), comparison operator behavior, type downgrading for efficient comparisons, and handling of non-standard comparisons between columns and constants.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/100.overview-of-character-set-and-collation.md", "description": "This document provides an overview of character sets and collations in seekdb, explaining how they enable storage and comparison of strings using different encodings and sorting rules, with support for specifying them at the database, table, or column level.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/200.character-set.md", "description": "This document describes the character sets supported by seekdb, including the default `utf8mb4`, usage of `SET NAMES` to specify session character sets, and details on implicit and explicit conversions—particularly between `gb18030` and `gb18030_2022`. It also provides instructions for listing available character sets using `SHOW CHARSET`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/300.collation.md", "description": "This document lists the character sets and collations supported by SeekDB, including details on Unicode, language-specific, and binary collations, along with performance notes and usage via `SHOW COLLATION`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/400.specify-character-set-and-collation.md", "description": "This document explains how to specify and select character sets and collations for databases in SeekDB using `CREATE DATABASE` and `ALTER DATABASE` statements, including syntax, examples, and rules for default behavior.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/500.table-level-character-set-and-collation.md", "description": "This document explains how to specify and manage character sets and collations at the table level in seekdb using `CREATE TABLE` and `ALTER TABLE` statements, including syntax for setting defaults and converting existing data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/600.column-level-character-set-and-collations.md", "description": "This document explains how to specify and manage character sets and collations at the column level in seekdb for `CHAR`, `VARCHAR`, and `TEXT` columns, including syntax for `CREATE TABLE` and `ALTER TABLE`, rules for default selection, sorting with collations, and conditions for safe character set conversion.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/700.character-expression-character-sets-and-collations.md", "description": "This document explains how character expressions in SQL statements are assigned character sets and collations in SeekDB, including the use of `_charset_name` prefixes and `COLLATE` clauses, with examples for UTF-8 and GB18030_2022 encodings.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/800.character-set-and-collation-for-client-connections.md", "description": "This document explains how character sets and collations are configured for client connections in SeekDB, covering relevant system variables (`character_set_client`, `character_set_connection`, `collation_connection`, etc.) and SQL statements like `SET NAMES` and `SET CHARACTER SET` to manage encoding and comparison behavior during client-server interactions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/100.literal-overview.md", "description": "This document provides an overview of literals in seekdb SQL, including supported types such as string, numeric, date and time, bit, boolean, and NULL literals, which are used as fixed values in expressions, conditions, and SQL statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/200.string-literal.md", "description": "This document describes string literals in SQL, including quote usage, binary vs. non-binary types, character set and collation specification with `COLLATE`, and supported escape sequences.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/300.numeric-value.md", "description": "This document describes numeric values in SQL, including exact (decimal/fixed-point) and approximate (floating-point) types, scientific notation, and hexadecimal literals with syntax rules and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/400.date-and-time.md", "description": "This document describes the syntax and formats for date, time, datetime, and timestamp literals in seekdb, including string and numeric representations, separator rules, fractional seconds, two-digit year interpretation, and valid value ranges.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/500.hexadecimal-numeric.md", "description": "This document describes the syntax and behavior of bit value literals in seekdb SQL, including valid formats (`b'...'`, `0b...`), their default treatment as binary strings, and methods to explicitly convert them to integers using `+0` or `CAST(... AS UNSIGNED)`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/600.boolean.md", "description": "This document describes Boolean literals in SQL, including the case-insensitive constants `TRUE` and `FALSE`, which evaluate to 1 and 0 respectively.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/700.null-value.md", "description": "This document explains the use of `NULL` values in SQL, including their behavior in comparisons, sorting with `ORDER BY`, and representation as `\\N` in `LOAD DATA` and `SELECT ... INTO OUTFILE` statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/500.schema-object-name.md", "description": "This document describes the syntax and rules for schema object names (identifiers) in SQL, including quoting with backticks, allowed characters, qualification with database/table prefixes, and usage of reserved words and special characters in identifiers.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/600.custom-variables.md", "description": "This document describes user-defined (custom) variables in seekdb, including their syntax (`@var_name`), session scope, data type handling, assignment via `SET` or inline expressions, limitations around evaluation order and parallel execution, compatibility considerations with MySQL, and special behavior for initialization in `FROM` subqueries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/100.basic-elements/700.annotation.md", "description": "This document describes the syntax and usage of SQL comments in seekdb, including single-line (`#`, `--`), multi-line (`/* */`), and executable version-specific comments (`/*! ... */`), as well as the use of the `COMMENT` clause to annotate database objects in DDL statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/100.operator-overview.md", "description": "This document provides an overview of SQL operators in seekdb, including unary and binary operators, their syntax, handling of NULL values, and links to detailed documentation on arithmetic, bitwise, comparison, logical, date/time, and character concatenation operators.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/1000.binary-conversion-operators.md", "description": "This document describes the `BINARY` conversion operator in seekdb, which converts expressions to binary strings for case-sensitive and space-sensitive comparisons, and explains equivalent syntaxes like `CONVERT(expr USING BINARY)` and `CAST(expr AS BINARY)`, along with distinctions between binary operators and binary column definitions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/1100.case-conditional-operator.md", "description": "This document describes the `CASE` conditional operator in SQL, which provides `IF...THEN...ELSE` logic directly within queries using two syntax forms: simple case (comparing a value against conditions) and searched case (evaluating boolean expressions).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/200.operator-precedence.md", "description": "This document describes the operator precedence rules in seekdb SQL, covering arithmetic, bitwise, comparison, logical, date/time, string concatenation, and collation operators, including how SQL modes like `PIPES_AS_CONCAT` and `HIGH_NOT_PRECEDENCE` affect behavior.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/300.arithmetic-operators.md", "description": "This document describes the arithmetic operators supported in seekdb, including `+`, `-`, `*`, `/`, `DIV`, and `MOD`/`%`, along with their syntax, operand types, behavior for integer and real-number operations, and rules for result precision and sign handling.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/400.bitwise-operators.md", "description": "This document describes the bitwise operators supported in seekdb, including AND (`&`), OR (`|`), NOT (`~`), XOR (`^`), left shift (`<<`), and right shift (`>>`), all operating on `BIGINT UNSIGNED` values as 64-bit unsigned integers.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/500.comparison-operators.md", "description": "This document describes the comparison operators supported by seekdb, including standard operators like `=`, `<>`, `<`, `>`, as well as NULL-safe comparisons (`<=>`), set membership (`[NOT] IN`), range checks (`[NOT] BETWEEN AND`), pattern matching (`[NOT] LIKE`), and Boolean/NULL tests (`IS [NOT] TRUE/FALSE/NULL`). It explains their syntax, behavior with NULL values, and provides usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/600.logical-operators.md", "description": "This document describes the logical operators (`NOT`/`!`, `AND`/`&&`, `OR`/`||`, and `XOR`) supported in seekdb SQL, including their behavior with `TRUE`, `FALSE`, and `NULL` values, along with syntax examples and evaluation rules.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/700.assignment-operator.md", "description": "This document describes the assignment operators `:=` and `=` in seekdb SQL, detailing their usage for variable and column assignment in `SET` and `UPDATE` statements, with examples illustrating scalar assignments, query results, and operator behavior differences.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/800.date-and-time-operators.md", "description": "This document describes the date and time operators (`+` and `-`) in seekdb, which provide shorthand for the `DATE_ADD` and `DATE_SUB` functions to perform arithmetic on datetime values and intervals.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/200.operator/900.character-concatenation-operators.md", "description": "This document describes the character concatenation operator (`||`) in seekdb, including its behavior under the `sql_mode` setting `PIPES_AS_CONCAT`, where it functions as a string concatenation operator instead of a logical OR.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/100.function-overview.md", "description": "This document provides an overview of all built-in functions in seekdb, including single-row, aggregate, analytic (window), encryption, information, JSON, XML, spatial, lock, bitmap, array, and other utility functions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/100.any-value.md", "description": "This document describes the `ANY_VALUE()` function in SQL, which allows queries to bypass `ONLY_FULL_GROUP_BY` mode restrictions by returning an arbitrary value from a group, enabling non-aggregated columns to be selected alongside aggregate functions without causing errors.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1400.inet-aton.md", "description": "This document describes the `INET_ATON` SQL function, which converts an IPv4 address from its string representation to an integer in network byte order, with guidance on using `INT UNSIGNED` columns for correct storage.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1500.inet-ntoa.md", "description": "This document describes the `INET_NTOA` SQL function, which converts an IPv4 address from its numeric representation in network byte order to a dotted-decimal string format (e.g., \"1.1.1.1\").", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1600.inet6-aton.md", "description": "This document describes the `INET6_ATON` SQL function, which converts IPv4 or IPv6 addresses to their binary representation in network byte order as a `VARBINARY` value, with details on supported formats, limitations, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1700.inet6-ntoa.md", "description": "This document describes the `INET6_NTOA` SQL function, which converts an IPv6 or IPv4 address from its numeric format to a human-readable string representation, returning `NULL` for invalid inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1800.is-ipv4.md", "description": "This document describes the `IS_IPV4` SQL function, which checks if a given expression is a valid IPv4 address string and returns 1 if true, 0 otherwise, with stricter validation than `INET_ATON()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1900.is-ipv4-compat.md", "description": "This document describes the `IS_IPV4_COMPAT` SQL function, which checks if a given IPv6 address in binary format (as returned by `INET6_ATON()`) is an IPv4-compatible address (i.e., in the form `::ipv4_address`) and returns 1 if true, otherwise 0.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/200.bin-to-uuid.md", "description": "This document describes the `BIN_TO_UUID()` SQL function, which converts a binary UUID (VARBINARY(16)) into its standard string representation in the format `aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee`, with optional support for swapping time-low and time-high components via a `swap_flag` parameter. It is the inverse of the `UUID_TO_BIN()` function and is used to ensure proper UUID formatting and compatibility in database operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2000.is-ipv6.md", "description": "This document describes the `IS_IPV6` SQL function, which checks if a given string is a valid IPv6 address and returns 1 if true, 0 otherwise—excluding IPv4 addresses.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2200.is-uuid.md", "description": "This document describes the `IS_UUID` SQL function, which validates whether a given string is a properly formatted UUID, returning 1 for valid UUIDs, 0 for invalid ones, and NULL if the input is NULL. It supports standard UUID formats with or without hyphens, braces, and case variations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2250.match-against.md", "description": "This document describes the `MATCH AGAINST` SQL function in seekdb, which enables full-text search using natural language or boolean modes, supports relevance scoring, and integrates with filtering, sorting, and index optimization strategies.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2300.nvl.md", "description": "This document describes the `NVL` function in SeekDB SQL, which replaces `NULL` values with a specified alternative value, supporting use cases like data cleaning and ensuring complete query results.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2400.uuid-to-bin.md", "description": "This document describes the `UUID_TO_BIN()` SQL function, which converts a string-formatted UUID to its binary representation (`VARBINARY(16)`), with optional time-part swapping for improved index efficiency when using UUID version 1 values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2500.sleep.md", "description": "This document describes the `SLEEP` SQL function in SeekDB, which pauses query execution for a specified duration in seconds and returns 0 if completed, 1 if interrupted when executed alone, or error code 1317 if interrupted within a query.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2600.uuid.md", "description": "This document describes the `UUID()` SQL function in SeekDB, which generates a globally unique identifier (UUID) as a string in standard UUID format.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2700.uuid-short.md", "description": "This document describes the `UUID_SHORT()` function in SeekDB, which generates a unique 64-bit unsigned integer identifier based on server ID, startup time, and an incrementing counter, under specific operational constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/300.coalesce.md", "description": "This document describes the `COALESCE` SQL function, which returns the first non-NULL expression from a list of arguments, requiring all expressions to be of the same or implicitly convertible type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/3000.values.md", "description": "This document describes the `VALUES()` function in SeekDB, which is used within `INSERT ... ON DUPLICATE KEY UPDATE` statements to reference column values from the INSERT clause for use in the UPDATE clause.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/400.default.md", "description": "This document describes the `DEFAULT` SQL function in SeekDB, which returns the default value of a specified column or `NULL` if no default is defined, and demonstrates its usage in `UPDATE` statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/500.name-const.md", "description": "This document describes the `NAME_CONST` SQL function, which returns a constant value with a specified column name in the result set, useful for assigning meaningful names to literal values in queries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/100.adddate.md", "description": "This document describes the `ADDDATE` SQL function, which adds a time interval or a specified number of days to a date, serving as a synonym for `DATE_ADD` in its interval-based form.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1000.date-format.md", "description": "This document describes the `DATE_FORMAT` function in SeekDB, which formats date and time values according to specified format codes, supporting a wide range of output patterns including day, month, year, hour, minute, second, week numbers, and AM/PM indicators.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1100.date-sub.md", "description": "This document describes the `DATE_SUB` SQL function, which subtracts a specified time interval from a date or datetime value, supporting various units including microseconds, seconds, minutes, hours, days, weeks, months, quarters, and years, as well as combined formats like `HOUR_MINUTE` or `YEAR_MONTH`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1200.datediff.md", "description": "This document describes the `DATEDIFF` single-row date and time function in SeekDB SQL, which calculates the number of days between two dates, ignoring time components.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1300.dayofmonth.md", "description": "This document describes the `DAYOFMONTH` SQL function in SeekDB, which returns the day of the month (1–31) from a given date or datetime value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1400.dayofweek.md", "description": "This document describes the `DAYOFWEEK` SQL function in SeekDB, which returns the day of the week for a given date or datetime value, with Sunday as day 1.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1500.dayofyear.md", "description": "This document describes the `DAYOFYEAR` SQL function, which returns the day of the year (1–366) for a given date or datetime value in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1600.extract.md", "description": "This document describes the `EXTRACT` function in SeekDB, which retrieves a specified date or time component (such as WEEK, YEAR_MONTH, or DAY) from a date value and returns it as an integer, with support for concatenated units and Sunday-based week numbering.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1700.from-days.md", "description": "This document describes the `FROM_DAYS` SQL function, which converts a numeric day count since year 0000-01-01 into a corresponding DATE value, with syntax and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1800.from-unixtime.md", "description": "This document describes the `FROM_UNIXTIME` single-row date and time function in SeekDB, which converts a Unix timestamp (seconds since 1970-01-01 00:00:00) into a DATETIME value or a formatted date-time string based on an optional format parameter.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1900.get-format.md", "description": "This document describes the `GET_FORMAT` single-row date and time function in SQL, which returns predefined format strings for DATE, TIME, DATETIME, and TIMESTAMP types based on regional standards (USA, EUR, JIS, ISO, INTERNAL), and is commonly used with `DATE_FORMAT` or `STR_TO_DATE`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/200.convert-tz.md", "description": "This document describes the `CONVERT_TZ` single-row date and time function in SeekDB SQL, which converts a datetime value from one time zone to another and returns `NULL` for invalid inputs or out-of-range timestamps.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2000.hour.md", "description": "This document describes the `HOUR` single-row date and time function in SeekDB SQL, which extracts the hour component from a time value, supporting both standard and extended time formats (e.g., '10:05:03' or '272:59:59').", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2100.last-day.md", "description": "This document describes the `LAST_DAY` SQL function, which returns the date of the last day of the month for a given input date. It includes syntax, usage examples, and output formatting for both date and datetime inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2200.localtime.md", "description": "This document describes the `LOCALTIME` SQL function in SeekDB, which returns the current date and time with optional microsecond precision, equivalent to the `NOW()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2300.localtimestamp.md", "description": "This document describes the `LOCALTIMESTAMP` SQL function in SeekDB, which returns the current date and time with optional microsecond precision (0–6 digits), and is equivalent to the `NOW()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2400.makedate.md", "description": "This document describes the `MAKEDATE` SQL function, which constructs a date from a given year and day-of-year value, returning `NULL` for invalid inputs such as non-positive days or results exceeding the year 9999.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2500.maketime.md", "description": "This document describes the `MAKETIME` SQL function, which constructs a time value from specified hour, minute, and second components, supporting fractional seconds.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2600.microsecond.md", "description": "This document describes the `MICROSECOND` SQL function in SeekDB, which extracts the microsecond component from a time or datetime expression, returning an integer value between 0 and 999999.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2700.minute.md", "description": "This document describes the `MINUTE` single-row date and time function in SeekDB SQL, which extracts the minute component from a given time value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2800.month.md", "description": "This document describes the `MONTH` single-row date and time function in SeekDB, which extracts the month component from a given date value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2900.monthname.md", "description": "This document describes the `MONTHNAME` SQL function in SeekDB, which returns the full name of the month (e.g., \"February\") from a given date value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/300.curdate.md", "description": "This document describes the `CURDATE()` function in SeekDB, which returns the current date without the time component, and includes syntax and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3000.now.md", "description": "This document describes the `NOW()` function in SeekDB, which returns the current date and time with optional microsecond precision, equivalent to `CURRENT_TIMESTAMP()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3100.period-add.md", "description": "This document describes the `PERIOD_ADD` SQL function, which adds a specified number of months to a period value in `YYMM` or `YYYYMM` format and returns the result in `YYYYMM` format.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3200.period-diff.md", "description": "This document describes the `PERIOD_DIFF` function in SeekDB, which calculates the number of months between two dates formatted as `YYYYMM` or `YYMM`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3300.quarter.md", "description": "This document describes the `QUARTER` SQL function in SeekDB, which extracts the quarter (1–4) from a given date or datetime value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3400.sec-to-time.md", "description": "This document describes the `SEC_TO_TIME` SQL function, which converts a given number of seconds into a `TIME` value formatted as `HH:MM:SS`, within the valid range of the `TIME` data type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3500.second.md", "description": "This document describes the `SECOND` single-row date and time function in SeekDB SQL, which extracts the seconds component from a given time value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3600.str-to-date.md", "description": "This document describes the `STR_TO_DATE` function in SeekDB, which converts a string to a `DATETIME`, `DATE`, or `TIME` value based on a specified format, detailing its behavior with various input types, SQL mode settings, and error handling.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3700.subdate.md", "description": "This document describes the `SUBDATE` function in SQL, which subtracts a time interval or a specified number of days from a date or datetime value, serving as a synonym for `DATE_SUB` when used with the `INTERVAL` keyword.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3800.subtime.md", "description": "The `SUBTIME` function in SQL subtracts a time value from a datetime or time expression and returns the result in the same format as the original expression. It is useful for performing precise time arithmetic in date and time calculations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3900.sysdate.md", "description": "This document describes the `SYSDATE` single-row date and time function in SeekDB SQL, which returns the current date and time with optional fractional seconds precision.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/400.current-date.md", "description": "This document describes the `CURRENT_DATE` SQL function in SeekDB, which returns the current date without the time component and serves as an alias for `CURDATE`. It includes syntax options and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4000.time.md", "description": "This document describes the `TIME` single-row date and time function in SeekDB, which extracts the time portion from a datetime value and returns it as a `TIME` type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4100.time-format.md", "description": "This document describes the `TIME_FORMAT` SQL function in SeekDB, which formats time values using specifiers for hours, minutes, seconds, and microseconds, supporting extended hour values beyond 23.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4200.time-to-sec.md", "description": "This document describes the `TIME_TO_SEC` SQL function in SeekDB, which converts a time value to the equivalent number of seconds. It includes syntax, description, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4300.time-to-usec.md", "description": "This document describes the `TIME_TO_USEC` function in SeekDB, which converts a date or datetime value to microseconds since the Unix epoch (1970-01-01 00:00:00.000000), accounting for timezone.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4400.timediff.md", "description": "This document describes the `TIMEDIFF` single-row date and time function in SeekDB, which calculates the time interval between two datetime values and returns the result as a `TIME` type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4500.timestamp.md", "description": "This document describes the `TIMESTAMP` single-row date and time function in SeekDB SQL, which either converts a datetime expression to a timestamp or adds a time interval to a datetime value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4600.timestampadd.md", "description": "This document describes the `TIMESTAMPADD` function in SeekDB, which adds a specified time interval to a date or datetime value, supporting units such as MICROSECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, and YEAR. It provides syntax, usage notes, and examples comparing it to the `DATE_ADD` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4700.timestampdiff.md", "description": "This document describes the `TIMESTAMPDIFF` function in SeekDB, which calculates the difference between two date-time values in a specified unit such as seconds, days, or other intervals supported by the `DATE_ADD` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4800.to-days.md", "description": "This document describes the `TO_DAYS` single-row date and time function in SeekDB, which returns the number of days since `0000-01-01` for a given date value, supporting both string and numeric date formats.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4900.to-seconds.md", "description": "This document describes the `TO_SECONDS` SQL function in SeekDB, which converts a date or datetime expression into the number of seconds since the beginning of year 0, returning `NULL` for `NULL` inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/500.current-time.md", "description": "This document describes the `CURRENT_TIME` single-row date and time function in SeekDB, which returns the current time without the date component, optionally specifying microsecond precision via a scale parameter from 0 to 6.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5000.unix-timestamp.md", "description": "This document describes the `UNIX_TIMESTAMP` function in SeekDB, which converts a given date/time or the current time to the number of seconds since the Unix epoch ('1970-01-01 00:00:00' UTC), supporting `DATE`, `DATETIME`, and `TIMESTAMP` input types.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5100.usec-to-time.md", "description": "This document describes the `USEC_TO_TIME` SQL function in seekdb, which converts a Unix timestamp in microseconds to a `TIMESTAMP` value in UTC timezone.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5200.utc-date.md", "description": "This document describes the `UTC_DATE()` function in SeekDB, which returns the current UTC date in `%Y-%m-%d` format and can be used in arithmetic operations to calculate future or past dates.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5300.utc-time.md", "description": "This document describes the `UTC_TIME` SQL function in SeekDB, which returns the current UTC time in `%H:%i:%s` format with optional fractional second precision (0–6 digits).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5400.utc-timestamp.md", "description": "This document describes the `UTC_TIMESTAMP` function in SeekDB, which returns the current UTC time in `%Y-%m-%d %H:%i:%s` format with optional fractional second precision (0–6 digits).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5500.week.md", "description": "This document describes the `WEEK` single-row date and time function in SeekDB SQL, which returns the week number of a given date within the year, with configurable modes that define the first day of the week and the logic for determining the first week of the year.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5600.weekday.md", "description": "This document describes the `WEEKDAY` SQL function in SeekDB, which returns the day-of-week index (0 = Monday, 6 = Sunday) for a given date value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5700.weekofyear.md", "description": "This document describes the `WEEKOFYEAR` single-row date and time function in SeekDB SQL, which returns the week number of a given date within its year.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5800.yearweek.md", "description": "This document describes the `YEARWEEK` SQL function in SeekDB, which returns the year and week number for a given date, with configurable week-start logic and first-week determination via an optional mode parameter.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5900.year.md", "description": "This document describes the `YEAR` single-row date and time function in SeekDB SQL, which extracts the year component from a given date value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/600.current-timestamp.md", "description": "This document describes the `CURRENT_TIMESTAMP` single-row date and time function in SeekDB, which returns the current date and time in the session time zone with optional microsecond precision specified by a scale parameter (0–6).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/6100.addtime.md", "description": "This document describes the `ADDTIME` SQL function in SeekDB, which adds a time expression to a datetime or time value and returns the resulting datetime or time. It includes syntax, parameter details, and examples demonstrating its use with both datetime and time inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/6200.dayname.md", "description": "This document describes the `DAYNAME` SQL function in SeekDB, which returns the name of the weekday (e.g., \"Thursday\") for a given date value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/6300.day.md", "description": "This document describes the `DAY` SQL function in SeekDB, which extracts the day of the month (1–31) from a given date value and serves as an alias for `DAYOFMONTH()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/700.curtime.md", "description": "This document describes the `CURTIME` function in SeekDB, which returns the current time without the date part and supports optional microsecond precision via a scale parameter (0–6); it is an alias for `CURRENT_TIME()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/800.date.md", "description": "This document describes the `DATE` single-row function in SeekDB, which extracts the date part from a datetime or time expression, returning it in 'YYYY-MM-DD' format.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/900.date-add.md", "description": "This document describes the `DATE_ADD` SQL function, which adds a specified time interval (such as days, hours, or combined units like 'DAY_HOUR') to a given date or datetime value, supporting both positive and negative intervals.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/100.ascii.md", "description": "This document describes the `ASCII` single-row string function in SQL, which returns the ASCII code of the leftmost character in a given string, with examples demonstrating its behavior for empty strings, NULL values, and standard input.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/1800.elt.md", "description": "This document describes the `ELT` string function in SQL, which returns the Nth string from a list of arguments and serves as the inverse of the `FIELD()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/1900.export_set.md", "description": "This document describes the `EXPORT_SET` SQL string function, which converts a numeric bit value into a formatted string representation using specified 'on' and 'off' strings, with configurable separator and bit length.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/200.bin.md", "description": "This document describes the `BIN` SQL function in SeekDB, which returns the binary representation of a given number and is equivalent to `CONV(N,10,2)`. It includes syntax, behavior for NULL inputs, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/2000.field.md", "description": "This document describes the `FIELD()` string function in SeekDB SQL, which returns the 1-based index of a specified string within a list of strings, or 0 if not found or if the search value is NULL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/2100.find_in_set.md", "description": "This document describes the `FIND_IN_SET` SQL string function, which returns the 1-based position of a string within a comma-separated list or 0 if not found, with support for NULL handling.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/2200.format.md", "description": "The `FORMAT` function formats a number with comma-separated thousands and rounds it to a specified number of decimal places, returning the result as a string.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/300.bit-length.md", "description": "This document describes the `BIT_LENGTH` SQL function in OceanBase, which returns the bit length of a given string, including its syntax, usage, and an example demonstrating how it calculates the bit length of the string 'oceanbase'.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3300.hex.md", "description": "This document describes the `HEX` SQL function in SeekDB, which converts a string or numeric input into its hexadecimal representation, with examples and notes on usage with numeric values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3400.insert.md", "description": "This document describes the `INSERT` string function in SQL, which replaces a substring in `str1` starting at position `pos` with length `len` using the string `str2`, supporting multibyte characters and handling edge cases like out-of-range positions or negative lengths.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3500.instr.md", "description": "This document describes the `INSTR` SQL string function, which returns the position of the first occurrence of a substring within a given string, equivalent to the two-argument form of `LOCATE()` with reversed arguments.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3600.int2ip.md", "description": "This document describes the `INT2IP` single-row string function in SeekDB, which converts an integer value into its corresponding IPv4 address representation by decomposing the integer into four octets. It includes syntax, calculation logic, handling of invalid or NULL inputs, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3700.ip2int.md", "description": "This document describes the `IP2INT` SQL function, which converts an IPv4 address in dotted-decimal format (e.g., 's1.s2.s3.s4') to its corresponding 32-bit unsigned integer representation using the formula: s1×2²⁴ + s2×2¹⁶ + s3×2⁸ + s4.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3750.keyvalue.md", "description": "This document describes the `KEYVALUE` string function in SeekDB, which extracts a value associated with a specified key from a delimited string of key-value pairs, supporting customizable delimiters for pair and key-value separation.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/400.char.md", "description": "This document describes the `CHAR` single-row string function in OceanBase SQL, which converts integer code values to their corresponding characters, supports multi-byte output for values over 255, allows character set specification via the `USING` clause, and handles invalid characters based on `sql_mode` settings.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/4800.lcase.md", "description": "This document describes the `LCASE` SQL string function, which converts uppercase letters in a string to lowercase and is synonymous with the `LOWER()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/4900.left.md", "description": "This document describes the `LEFT` string function in SQL, which returns the leftmost specified number of characters from a given string, supporting multibyte characters and returning `NULL` if either input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/500.char-length.md", "description": "This document describes the `CHAR_LENGTH` SQL function, which returns the number of characters in a string, counting multi-byte characters as single characters—useful for accurately measuring string length in character-based contexts.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5000.length.md", "description": "This document describes the `LENGTH` SQL function, which returns the length of a string in bytes, counting multibyte characters as multiple bytes—useful for distinguishing between byte length and character count in string operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5100.locate.md", "description": "This document describes the `LOCATE` string function in SQL, which returns the position of the first occurrence of a substring within a string, optionally starting from a specified position.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5200.lower.md", "description": "This document describes the `LOWER` SQL string function, which converts uppercase letters in a string to lowercase and is synonymous with `LCASE()`. It includes syntax, usage, and an example query result.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5300.lpad.md", "description": "This document describes the `LPAD` string function in SQL, which left-pads a string to a specified length using a given padding string, truncating or extending as needed.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5400.ltrim.md", "description": "This document describes the `LTRIM` SQL function, which removes leading whitespace from a string, including its syntax, usage, and an example demonstrating its behavior in a SELECT query.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5500.make-set.md", "description": "This document describes the `MAKE_SET` string function in SQL, which returns a comma-separated list of strings corresponding to bits set in a given integer bitmask.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5550.md5-concat-ws.md", "description": "This document describes the `MD5_CONCAT_WS` SQL function, which concatenates multiple strings with a specified separator, replaces NULL values with a given placeholder, and returns the MD5 hash of the resulting string. It includes syntax, parameters, considerations for hash collisions and NULL handling, and usage examples in OceanBase Database.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5600.mid.md", "description": "This document describes the `MID` string function in SQL, which extracts a substring from a given string starting at a specified position and with an optional length; it is equivalent to the `SUBSTRING` function and handles `NULL` inputs, negative positions, and edge cases like zero or negative lengths.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5700.oct.md", "description": "This document describes the `OCT` SQL function in SeekDB, which converts a decimal number to its octal representation and is equivalent to `CONV(N,10,8)`. It returns `NULL` if the input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5800.octet-length.md", "description": "This document describes the `OCTET_LENGTH()` SQL function, a synonym of `LENGTH()`, which returns the number of bytes in a given string.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5900.ord.md", "description": "This document describes the `ORD` SQL function, which returns the ASCII value of the leftmost character in a string, supporting both single-byte and multibyte character encodings by computing a weighted sum of byte values for multibyte characters.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/600.character-length.md", "description": "This document describes the `CHARACTER_LENGTH` SQL function, a synonym for `CHAR_LENGTH`, which returns the number of characters in a given string, with examples illustrating its usage and distinction from the `LENGTH` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/6000.position.md", "description": "This document describes the `POSITION` string function in SQL, which returns the starting position of the first occurrence of a substring within a given string.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/700.concat.md", "description": "This document describes the `CONCAT` function in SQL, which concatenates multiple strings into a single string, handling binary and non-binary inputs, numeric conversions, and `NULL` values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7000.quote.md", "description": "This document describes the `QUOTE` string function in SeekDB, which escapes special characters in a string for safe inclusion in SQL statements by enclosing the result in single quotes and escaping backslashes, single quotes, NUL bytes, and Ctrl+Z characters; it returns the unquoted string `'NULL'` when the input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7100.regexp.md", "description": "This document describes the `REGEXP` (or `RLIKE`) string function in SeekDB SQL, which performs regular expression pattern matching and returns `NULL` if any input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7200.regexp-instr.md", "description": "This document describes the `REGEXP_INSTR` string function in SQL, which returns the starting (or ending) position of a substring matching a regular expression pattern within a given string, with options to specify search position, occurrence, and match type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7300.regexp-like.md", "description": "This document describes the `REGEXP_LIKE` function in OceanBase SQL, which performs regular expression pattern matching on strings and supports optional match types for case sensitivity, newline handling, and line ending recognition.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7400.regexp-replace.md", "description": "This document describes the `REGEXP_REPLACE` SQL function in OceanBase Database, which replaces substrings matching a regular expression pattern with a specified replacement string, supporting optional parameters for position, occurrence, and match type.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7500.regexp-substr.md", "description": "This document describes the `REGEXP_SUBSTR` SQL function, which extracts a substring matching a regular expression pattern from a given string, with support for multi-byte characters, configurable search position, occurrence count, match parameters, and subexpression selection.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7600.repeat.md", "description": "This document describes the `REPEAT` string function in SeekDB SQL, which returns a string repeated a specified number of times, returning an empty string for non-positive counts and `NULL` if any input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7700.replace-func.md", "description": "This document describes the `REPLACE()` string function in seekdb, which replaces all occurrences of a specified substring within a string with another substring. It covers syntax, parameters, case sensitivity, NULL handling, multibyte safety, and compatibility with MySQL 8.0 behavior.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7800.reverse.md", "description": "This document describes the `REVERSE` string function in SQL, which returns the reversed version of a given string or numeric input, and is safe for multibyte characters.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7900.right.md", "description": "This document describes the `RIGHT` string function in SQL, which returns the rightmost specified number of characters from a given string, supporting multibyte characters and returning `NULL` if any input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/800.concat-ws.md", "description": "This document describes the `CONCAT_WS` SQL function in SeekDB, which concatenates multiple strings with a specified separator, ignoring `NULL` values but not empty strings.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8000.rlike.md", "description": "This document describes the `RLIKE` string function in SeekDB, which tests whether a string matches a regular expression pattern and returns 1 for a match, 0 for no match, or NULL if either input is NULL. It is equivalent to the `REGEXP()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8100.rpad.md", "description": "This document describes the `RPAD` string function in SeekDB SQL, which pads a given string on the right with a specified padding string to reach a desired total length, truncating or repeating the padding as needed.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8200.rtrim.md", "description": "This document describes the `RTRIM` SQL function, which removes trailing spaces from a given string, and includes its syntax and usage example.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8300.space.md", "description": "This document describes the `SPACE` SQL function, which returns a string containing a specified number of space characters.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8350.split_part.md", "description": "This document describes the `SPLIT_PART` string function in SeekDB, which extracts a substring from a delimited string by specifying a start (and optionally end) position, supporting both forward and reverse indexing.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8400.strcmp.md", "description": "This document describes the `STRCMP` string function in SeekDB SQL, which compares two strings and returns 0 if they are equal, -1 if the first is a substring of the second, and 1 if the second is a substring of the first.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8500.substr.md", "description": "This document describes the `SUBSTR` string function in SeekDB SQL, which extracts a substring from a given string starting at a specified position and optionally limited to a specified length, supporting both positive and negative indexing.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8600.substring.md", "description": "This document describes the `SUBSTRING` SQL function in SeekDB, including its syntax, behavior with positive and negative positions, optional length parameter, handling of NULL and invalid inputs, and examples demonstrating its usage as an alias for `SUBSTR()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8700.substring_index.md", "description": "This document describes the `SUBSTRING_INDEX` string function in SeekDB SQL, which extracts a substring from a given string based on a delimiter and occurrence count, supporting both positive (from start) and negative (from end) indexing.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8800.trim.md", "description": "This document describes the `TRIM` SQL function in SeekDB, which removes leading and/or trailing characters from a string, supporting `BOTH`, `LEADING`, and `TRAILING` options with examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8900.ucase.md", "description": "This document describes the `UCASE` SQL function, which converts lowercase characters in a string to uppercase and is equivalent to the `UPPER()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9000.unhex.md", "description": "This document describes the `UNHEX` SQL function in OceanBase Database, which converts a hexadecimal string into its binary representation, returning `NULL` for invalid input or zero-filled binary values, and includes usage examples and notes on handling binary data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9100.upper.md", "description": "This document describes the `UPPER` string function in SQL, which converts all lowercase letters in a given string to uppercase. It includes syntax, usage notes, and an example demonstrating its behavior in a SELECT statement.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9150.url_decode.md", "description": "This document describes the `URL_DECODE` SQL function, which decodes a URL-encoded string by converting percent-encoded characters (e.g., `%3A`) back to their original form, supporting only the `utf8` character set and returning a `VARCHAR` or `NULL` if the input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9170.url_encode.md", "description": "This document describes the `URL_ENCODE` SQL function in SeekDB, which encodes non-ASCII and special characters in a string using percent-encoding (e.g., space becomes `%20`), supporting only the `utf8` character set and returning a `VARCHAR` or `NULL` if input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9200.weight-string.md", "description": "This document describes the `WEIGHT_STRING()` SQL function in SeekDB, which returns the collation weight of a string as a binary value for comparison and sorting purposes. It covers syntax, usage of the `AS` and `LEVEL` clauses, behavior with binary vs. non-binary strings, and examples demonstrating weight calculation, level modifiers (`ASC`, `DESC`, `REVERSE`), and hexadecimal output.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9300.to-base64.md", "description": "This document describes the `TO_BASE64` SQL function, which encodes a given string into its Base64 representation, commonly used for data encoding in transit or storage.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9400.from-base64.md", "description": "This document describes the `FROM_BASE64()` SQL function, which decodes a base64-encoded string into its original binary form, commonly used in conjunction with the `TO_BASE64()` function for data encoding and decoding operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9500.soundex.md", "description": "This document describes the `SOUNDEX` SQL function, which converts a string into a phonetic code for fuzzy matching of similarly pronounced words in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/100.cast.md", "description": "This document describes the `CAST` function in seekdb, which explicitly converts an expression from one data type to another, supporting conversions to types such as `CHAR`, `DATE`, `DATETIME`, `DECIMAL`, `SIGNED`/`UNSIGNED`, `JSON`, `TIME`, and `ARRAY`, with details on syntax, parameters, behavior, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1000.scn-to-timestamp.md", "description": "This document describes the `SCN_TO_TIMESTAMP()` SQL function in OceanBase Database, which converts a System Change Number (SCN) to a human-readable `DATETIME` value, commonly used for correlating internal log positions with timestamps.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1500.timestamp-to-scn.md", "description": "This document describes the `TIMESTAMP_TO_SCN()` SQL function, which converts a given timestamp to its corresponding System Change Number (SCN) in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1600.to_char_character.md", "description": "This document describes the `TO_CHAR(character)` function in SeekDB, which converts character data to a `VARCHAR` string, returning `NULL` if the input is `NULL`. It includes syntax, parameters, return type, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1700.to_char_number.md", "description": "This document describes the `TO_CHAR(number)` function in SeekDB, which converts numeric values to formatted `VARCHAR` strings using optional format models (`fmt`) for numeric representation, grouping, currency symbols, sign handling, and other formatting options.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1800.to_char_datetime.md", "description": "This document describes the `TO_CHAR(datetime)` function in SeekDB, which converts a datetime value to a VARCHAR string with optional formatting using format models such as `YYYY`, `MM`, `DD`, `HH24`, and locale-sensitive elements like `MONTH` or `DAY`. It covers syntax, parameters, format specifiers, return type, examples, and related functions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/200.convert.md", "description": "This document describes the `CONVERT` function in SeekDB SQL, which supports two forms: converting an expression to a specified character set using `CONVERT(expr USING transcoding_name)`, or converting an expression to a specified data type with `CONVERT(expr, type)`, equivalent to the `CAST` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/300.decode-trace-id.md", "description": "This document describes the `DECODE_TRACE_ID()` SQL function in OceanBase Database, which decodes a trace ID to return the IP address and port of the server that originated the SQL request, useful for auditing and troubleshooting via views like `GV$OB_SQL_AUDIT`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/100.abs.md", "description": "This document describes the `ABS` single-row mathematical function in SeekDB SQL, which returns the absolute value of a numeric expression, supports type conversion from numeric strings, handles `NULL` inputs, and can be used in comparison operations that return boolean results as numeric values (`1` for `TRUE`, `0` for `FALSE`).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1000.cos.md", "description": "This document describes the `COS` single-row mathematical function in SQL, which returns the cosine of a given angle in radians.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1100.cot.md", "description": "This document describes the `COT` single-row mathematical function in SeekDB SQL, which returns the cotangent of a given numeric input `X`, with example usage and output.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1200.crc32.md", "description": "This document describes the `CRC32` single-row mathematical function in SQL, which computes a 32-bit cyclic redundancy check value for a given string expression and returns `NULL` if the input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1300.degrees.md", "description": "This document describes the `DEGREES()` SQL function in SeekDB, which converts an angle expressed in radians to degrees, including syntax and usage examples with `PI()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1400.exp.md", "description": "This document describes the `EXP` single-row mathematical function in SeekDB SQL, which returns the value of the natural logarithm base *e* raised to the power of a given number `X`, with usage examples demonstrating positive, zero, and negative inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1500.floor.md", "description": "This document describes the `FLOOR` single-row mathematical function in SeekDB SQL, which returns the largest integer less than or equal to a given expression, supporting numeric, boolean, and string inputs, with examples demonstrating its behavior on various data types.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1600.generator.md", "description": "This document describes the `GENERATOR(N)` table function in SeekDB, which produces N empty rows for use in generating synthetic data, enabling operations like random value generation, Cartesian joins, and parallel query execution.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1600.ln.md", "description": "This document describes the `LN` SQL function in SeekDB, which computes the natural logarithm (base *e*) of a given value, returning `NULL` and issuing a warning for non-positive inputs. It is equivalent to the `LOG` function and is used for mathematical computations in single-row contexts.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1700.log.md", "description": "This document describes the `LOG` single-row mathematical function in SeekDB SQL, which computes the natural logarithm (base *e*) of a number or the logarithm with a specified base, returning `NULL` for invalid inputs such as non-positive values or bases ≤ 1.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1800.log10.md", "description": "This document describes the `LOG10` single-row mathematical function in SeekDB, which returns the base-10 logarithm of a given numeric value and handles invalid inputs (e.g., negative numbers) by returning NULL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1900.log2.md", "description": "This document describes the `LOG2` single-row mathematical function in SQL, which returns the base-2 logarithm of a given value `X`, returning `NULL` for non-positive inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/200.acos.md", "description": "This document describes the `ACOS` single-row mathematical function in SQL, which returns the inverse cosine of a given value `X`, returning `NULL` if `X` is outside the valid range `[-1, 1]`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2000.mod.md", "description": "This document describes the `MOD` function in SeekDB SQL, which returns the remainder of a division operation and supports decimal values, with equivalent syntaxes `MOD(N,M)`, `N % M`, and `N MOD M`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2100.neg.md", "description": "This document describes the `NEG` single-row mathematical function in SeekDB SQL, which returns the negation of a numeric expression or the negated boolean result (as 0 or -1) of a comparison operation.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2200.normal.md", "description": "This document describes the `NORMAL` single-row mathematical function in SeekDB, which generates random numbers following a normal (Gaussian) distribution using specified mean, standard deviation, and a random value generator. It includes syntax, parameter constraints, implementation details (Marsaglia Polar Method), and usage examples with performance considerations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2200.pi.md", "description": "This document describes the `PI()` single-row mathematical function in SeekDB SQL, which returns the constant value of π (pi), approximately 3.141593, and can be used in calculations such as circumference or area formulas.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2300.pow.md", "description": "This document describes the `POW` mathematical function in SeekDB SQL, which returns the value of X raised to the power of Y, returning NULL if either argument is NULL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2400.power.md", "description": "This document describes the `POWER` function in SeekDB, which returns the value of X raised to the power of Y and serves as an alias for `POW()`, returning `NULL` if either argument is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2500.radians.md", "description": "This document describes the `RADIANS` single-row mathematical function in SQL, which converts an angle from degrees to radians. It includes syntax, usage notes, and examples demonstrating conversion of positive, negative, and fractional degree values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2600.rand.md", "description": "This document describes the `RAND([N])` SQL function in SeekDB, which generates random floating-point numbers in the range [0, 1.0), supports optional seeding for reproducible results, and can be used in SELECT, WHERE, ORDER BY, and GROUP BY clauses for tasks like random sampling and shuffling.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2800.random.md", "description": "This document describes the `RANDOM(seed)` function in SeekDB, a single-row mathematical function that generates 64-bit pseudo-random integers using the MT19937 algorithm, with examples demonstrating its use for seeding random number sequences and integration with other functions like `UNIFORM`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2900.randstr.md", "description": "This document describes the `RANDSTR` single-row mathematical function in SeekDB, which generates random strings of a specified length using uppercase letters, lowercase letters, and digits, with support for controlling randomness via distribution functions like uniform, Zipf, or Gaussian, and includes behavior details for edge cases and performance considerations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/300.asin.md", "description": "This document describes the `ASIN` single-row mathematical function in SeekDB SQL, which returns the inverse sine (arcsine) of a given value `X`, returning `NULL` if `X` is outside the valid range `[-1, 1]`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3000.round.md", "description": "This document describes the `ROUND` single-row mathematical function in SQL, which rounds a numeric value to the nearest integer or to a specified number of decimal places, supporting both exact and approximate numeric types with distinct rounding rules.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3100.sign.md", "description": "This document describes the `SIGN` single-row mathematical function in SQL, which returns -1, 0, or 1 depending on whether the input value is negative, zero, or positive, and supports floating-point, hexadecimal, and boolean inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3200.sin.md", "description": "This document describes the `SIN` single-row mathematical function in SQL, which returns the sine of a given angle in radians.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3300.sqrt.md", "description": "This document describes the `SQRT` single-row mathematical function in SeekDB SQL, which returns the square root of a given numeric value and returns `NULL` for negative inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3400.tan.md", "description": "This document describes the `TAN` single-row mathematical function in SQL, which returns the tangent of a given angle in radians. It includes syntax, usage example, and expected output.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3500.truncate.md", "description": "This document describes the `TRUNCATE` single-row mathematical function in SeekDB SQL, which truncates a number `X` to `D` decimal places—returning an integer if `D` is 0 or zeroing digits left of the decimal point if `D` is negative.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/400.atan.md", "description": "This document describes the `ATAN` single-row mathematical function in SeekDB SQL, which returns the arctangent of a given value `X`, with syntax and example usage provided.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/4000.uniform.md", "description": "This document describes the `UNIFORM()` function in SeekDB, a mathematical single-row function that generates random values following a uniform distribution between specified minimum and maximum bounds, with return type (integer or float) determined by the input parameter types.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/500.atan2.md", "description": "This document describes the `ATAN2` (or `ATAN`) single-row mathematical function in SeekDB SQL, which computes the arctangent of two arguments `X` and `Y`, using their signs to determine the correct quadrant of the result.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/5000.zipf.md", "description": "This document describes the `ZIPF` single-row mathematical function in SeekDB SQL, which generates integers following a Zipf distribution with specified parameters `s` (exponent), `N` (range size), and a random generator `gen`, commonly used for simulating skewed data distributions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/600.bit-count.md", "description": "This document describes the `BIT_COUNT` SQL function, which returns the number of `1` bits in the binary representation of a given integer value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/700.ceil.md", "description": "This document describes the `CEIL` single-row mathematical function in SeekDB SQL, which returns the smallest integer greater than or equal to a given numeric expression, with support for automatic type conversion and handling of NULL values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/800.ceiling.md", "description": "This document describes the `CEILING` (or `CEIL`) SQL function in SeekDB, which returns the smallest integer greater than or equal to a given numeric value, with support for automatic type conversion, NULL handling, and boolean-to-numeric coercion.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/900.conv.md", "description": "This document describes the `CONV` SQL function, which converts a number from one numerical base to another, supporting bases from 2 to 36 (with optional signed interpretation via negative base values), and details its syntax, input constraints, error conditions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/100.greatest.md", "description": "This document describes the `GREATEST` SQL function, which returns the maximum value among two or more provided arguments, handling numeric, string, and date types with implicit conversions and returning `NULL` if any argument is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/200.interval.md", "description": "This document describes the `INTERVAL` single-row comparison function in SQL, which returns the index of the first value in a sorted list that is greater than the given value, with support for `NULL` handling and use cases like bucketing or range-based categorization.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/300.isnull.md", "description": "This document describes the `ISNULL` single-row comparison function in SeekDB SQL, which returns `1` if the input expression is `NULL` and `0` otherwise, providing a reliable alternative to equality comparisons with `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/400.least.md", "description": "The `LEAST` function returns the smallest value among its arguments, returning `NULL` if any argument is `NULL`, and requiring at least two parameters. It supports numeric, string, and date comparisons with implicit type conversion where applicable.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/100.case.md", "description": "This document describes the `CASE` expression in SeekDB SQL, a conditional control function that evaluates conditions or compares values and returns corresponding results, with support for both simple value matching and boolean condition syntax.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/200.if.md", "description": "This document describes the `IF` single-row process control function in SQL, which returns one of two values based on a conditional expression, with details on syntax, behavior with `NULL` and boolean logic, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/300.ifnull.md", "description": "This document describes the `IFNULL` single-row process control function in SQL, which returns the first expression if it is not NULL, otherwise returns the second expression, with return type determined by the input expressions' types.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/400.nullif.md", "description": "This document describes the `NULLIF` single-row process control function in SQL, which returns `NULL` if two expressions are equal and otherwise returns the first expression, with examples illustrating its behavior.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/500.ora-decode.md", "description": "This document describes the `ORA_DECODE` function, a single-row process control function that mimics Oracle's `DECODE`, enabling conditional value mapping by comparing an input expression to a series of values and returning corresponding results or a default.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/100.approx-count-distinct-agg.md", "description": "This document describes the `APPROX_COUNT_DISTINCT` aggregate function in SeekDB SQL, which returns an approximate count of distinct values in a column or expression, useful for estimating column selectivity with reduced computational overhead.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1000.min-agg.md", "description": "This document describes the `MIN` aggregate function in SQL, which returns the smallest value from a specified column or expression, supporting both numeric and string data types, with optional use of `DISTINCT` to consider only unique values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1100.std-agg.md", "description": "This document describes the `STD` aggregate function in SeekDB, which calculates the population standard deviation of a numeric expression and serves as an alias for `STDDEV_POP()`. It includes syntax, behavior (returning `NULL` for empty result sets), and a practical example using employee salary data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1200.stfdev-agg.md", "description": "This document describes the `STDDEV` aggregate SQL function, which calculates the population standard deviation of a given expression and serves as an alias for `STDDEV_POP()`. It includes syntax, behavior (returning `NULL` for empty result sets), and a practical example using an employee salary dataset.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1300.srddev-pop-agg.md", "description": "This document describes the `STDDEV_POP` aggregate function in SQL, which calculates the population standard deviation of a given expression and returns `NULL` if no rows match the condition.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1400.srddev-samp-agg.md", "description": "This document describes the `STDDEV_SAMP` aggregate SQL function, which calculates the sample standard deviation of a numeric expression, equivalent to the square root of `VAR_SAMP`. It returns `NULL` if no rows match the query condition and is commonly used in statistical analysis of datasets.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1500.sum-agg.md", "description": "This document describes the `SUM` aggregate function in SQL, which calculates the total of a numeric expression, optionally over distinct values, and returns `NULL` if no rows match or the input contains only `NULL`s.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1600.var-pop-agg.md", "description": "This document describes the `VAR_POP` aggregate SQL function, which calculates the population variance of a given expression. It returns `NULL` if no rows match the query condition and is commonly used in statistical analysis to measure data dispersion across an entire population.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1700.var-samp-agg.md", "description": "This document describes the `VAR_SAMP` aggregate SQL function, which calculates the sample variance of a given expression and returns `NULL` for single-value or empty result sets.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1800.variance-agg.md", "description": "This document describes the `VARIANCE` aggregate SQL function in SeekDB, which computes the population variance of a numeric expression and serves as an alias for `VAR_POP()`, returning `NULL` when no rows match.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/200.avg-agg.md", "description": "This document describes the `AVG` aggregate function in SQL, which calculates the average of a set of values, optionally distinct, ignoring NULLs, and returns NULL if no rows match.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/300.bit-and-agg.md", "description": "This document describes the `BIT_AND` aggregate function in SQL, which computes the bitwise AND of all non-NULL values in a group, returning a neutral value (all bits set to 1) when no rows match or all values are NULL. It covers syntax, behavior with binary strings vs. numeric inputs, and includes practical examples using product data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/400.bit-or-agg.md", "description": "This document describes the `BIT_OR` aggregate SQL function in SeekDB, which computes the bitwise OR of all non-NULL values in a group, supporting both numeric and binary string inputs, and returning a neutral (all-zero) value when no rows match or all values are NULL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/500.bit-xor-agg.md", "description": "This document describes the `BIT_XOR` aggregate function in SeekDB SQL, which computes the bitwise XOR of all non-NULL values in a group, supporting both binary string and numeric inputs, and returning a neutral (zero-bit) value when no rows match or all values are NULL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/600.count-agg.md", "description": "This document describes the `COUNT` aggregate function in SQL, including its syntax, behavior with `NULL` values, use of `DISTINCT` and `ALL` options, and differences between `COUNT(*)` and `COUNT(expr)`, with practical examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/700.group-concat-agg.md", "description": "This document describes the `GROUP_CONCAT` aggregate function in SQL, including its syntax, usage with `DISTINCT`, `ORDER BY`, and `SEPARATOR` clauses, and examples demonstrating how it concatenates non-NULL values within grouped rows.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/800.grouping-agg.md", "description": "This document describes the `GROUPING` aggregate function in SQL, which is used with `GROUP BY ... WITH ROLLUP` to identify super-aggregation rows by returning 1 for aggregated (NULL) group values and 0 for regular grouped values. It includes syntax, examples, and use cases for distinguishing summary rows in hierarchical aggregations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/900.max-agg-agg.md", "description": "This document describes the `MAX` aggregate SQL function in SeekDB, which returns the maximum value from a specified column or expression, supporting both numeric and string data types, with optional `DISTINCT` or `ALL` modifiers.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/100.approx-count_distinct.md", "description": "This document describes the `APPROX_COUNT_DISTINCT` SQL analysis function, which provides an approximate count of distinct values in a column with high performance and negligible error, ideal for large datasets. It includes syntax, usage notes, and a practical example demonstrating its application with windowing clauses.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1300.count.md", "description": "This document describes the `COUNT` analytic function in SQL, including its syntax, behavior with `NULL` values, use of `DISTINCT`, and examples demonstrating its application in windowed queries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1400.cume-dist.md", "description": "This document describes the `CUME_DIST` analytic SQL function, which computes the cumulative distribution of a row within a partition—returning a value between 0 and 1 based on the proportion of rows with values less than or equal to the current row. It includes syntax, explanation, and an example using employee salary data partitioned by job role.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1500.dense-rank.md", "description": "This document describes the `DENSE_RANK` analytic SQL function in SeekDB, which assigns a continuous rank to rows within a result set partition, ensuring no gaps in ranking values even when ties occur. It includes syntax, behavior explanation, and a practical example comparing `DENSE_RANK` with `RANK` and `PERCENT_RANK`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1600.first_value.md", "description": "This document describes the `FIRST_VALUE` analytic function in SQL, which returns the first value of an expression within a partition of a result set, with options to respect or ignore nulls. It includes syntax details and an example demonstrating its use alongside other analytic functions like `LAST_VALUE` and `NTH_VALUE`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/200.avg.md", "description": "This document describes the `AVG` analytic function in SQL, which calculates the average of a set of values within a specified group or window, ignoring NULLs, and supports options like `DISTINCT` and windowing clauses for advanced analytics.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2700.lag.md", "description": "This document describes the `LAG()` window function in SQL, which accesses data from a previous row within the same result set without using a self-join. It includes syntax, parameter details, and examples showing how to retrieve prior row values based on a specified offset and ordering.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2800.last-value.md", "description": "This document describes the `LAST_VALUE` analytic SQL function in SeekDB, which returns the last value of a specified expression within a partition, with options to respect or ignore NULLs, and includes syntax details and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2900.lead.md", "description": "This document describes the `LEAD` window function in SQL, which retrieves data from a subsequent row within the same result set, supporting parameters for offset, default value, and null handling, commonly used for time-series or ordered data analysis.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/300.bit-and.md", "description": "This document describes the `BIT_AND` analytic function in SQL, which computes the bitwise AND of all non-NULL values in a group or window, returning a neutral value (all bits set to 1) when no rows match or all values are NULL. It includes syntax, behavior for binary and numeric inputs, and usage examples with sample data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3000.max.md", "description": "This document describes the `MAX()` analytic function in SQL, which returns the maximum value—numeric or string—within a specified partition or dataset, supporting optional `DISTINCT` or `ALL` keywords and windowing clauses.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3100.min.md", "description": "This document describes the `MIN()` analytic function in SeekDB SQL, which returns the minimum value (numeric or string) within a specified partition or result set, supporting optional `DISTINCT` or `ALL` keywords and windowing via the `OVER` clause.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3200.nth-value.md", "description": "This document describes the `NTH_VALUE` analytic SQL function, which retrieves the value at the nth position within a window frame, supporting options to specify direction (`FROM FIRST` or `FROM LAST`) and handle nulls (`RESPECT NULLS` or `IGNORE NULLS`).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3300.ntile.md", "description": "This document describes the `NTILE` analytic SQL function in SeekDB, which divides partitioned, ordered rows into a specified number of approximately equal-sized groups and returns the group number for each row. It includes syntax, behavior for NULL inputs, and an example demonstrating its use with employee salary data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3400.percent-rank.md", "description": "This document describes the `PERCENT_RANK` analytic SQL function in SeekDB, including its syntax, behavior, and usage examples for calculating the relative rank of rows as a percentage within a partitioned and ordered dataset.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3450.percentile_cont.md", "description": "This document describes the `PERCENTILE_CONT` analytical SQL function in SeekDB, which computes exact percentiles via linear interpolation for numeric data types, excluding `DATETIME`, and automatically ignores `NULL` values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3500.rank.md", "description": "This document describes the `RANK()` window function in SQL, which assigns a unique rank to each row within a partition of a result set, with gaps in ranking when ties occur. It includes syntax, explanation of partitioning and ordering clauses, and a practical example using an `employees` table.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3600.row_number.md", "description": "This document describes the `ROW_NUMBER()` window function in SQL, which assigns a unique sequential integer to rows within a partition of a result set, ordered by specified columns. It includes syntax, usage, and an example demonstrating its application for ranking employees by salary within job roles.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3700.std.md", "description": "This document describes the `STD` analytical SQL function in SeekDB, which computes the population standard deviation (equivalent to `STDDEV_POP`) of a given expression over a defined window, returning `NULL` for empty result sets.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3800.stddev.md", "description": "This document describes the `STDDEV` analytic SQL function in SeekDB, which calculates the standard deviation of an expression and serves as an alias for `STDDEV_POP`, returning `NULL` when no rows match the condition.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3900.stddev-pop.md", "description": "This document describes the `STDDEV_POP` analytic SQL function, which calculates the population standard deviation of a numeric expression over a specified window of rows. It includes syntax, behavior for empty result sets (returns `NULL`), and a practical example using employee salary data partitioned by hire date.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/400.bit-or.md", "description": "This document describes the `BIT_OR` analytic SQL function in SeekDB, which computes the bitwise OR of all non-NULL values in a group or window, supporting both numeric and binary string inputs, with examples demonstrating its usage over partitioned data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4000.stddev-samp.md", "description": "This document describes the `STDDEV_SAMP` analytic SQL function, which calculates the sample standard deviation of a numeric expression and is equivalent to the square root of `VAR_SAMP`. It includes syntax, behavior for empty result sets, and a practical example using employee salary data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4100.sum.md", "description": "This document describes the `SUM` analytic function in SQL, which calculates the total of a specified expression within a result set or partition, supporting optional `DISTINCT` or `ALL` keywords and windowing clauses.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4200.var-pop.md", "description": "This document describes the `VAR_POP` analytical SQL function, which calculates the population variance of a given expression over a specified window, returning `NULL` if no rows match the query.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4300.var-samp.md", "description": "This document describes the `VAR_SAMP` SQL analytic function, which calculates the sample variance of a given expression over a specified window, returning `NULL` if no rows are matched. It includes syntax, usage notes, and an example demonstrating its application on employee salary data.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4400.variance.md", "description": "This document describes the `VARIANCE` analytic SQL function in SeekDB, which computes the population variance of a numeric expression—equivalent to `VAR_POP`—and includes syntax, behavior for empty result sets, and a practical example using employee salary data partitioned by hire date.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/500.bit-xor.md", "description": "This document describes the `BIT_XOR` analytic SQL function in SeekDB, which computes the bitwise XOR of all non-NULL values in a group or window, supporting both numeric and binary string inputs, with examples demonstrating its use in partitioned data analysis.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/100.aes-decrypt.md", "description": "This document describes the `AES_DECRYPT` SQL function in OceanBase Database, which decrypts ciphertext using a specified key and optional initialization vector, supporting AES encryption/decryption workflows.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1000.md5.md", "description": "This document describes the `MD5` function in SeekDB, which computes and returns the 128-bit MD5 hash of a given string as a 32-character hexadecimal string, returning `NULL` if the input is `NULL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1050.password.md", "description": "This document describes the `PASSWORD` SQL function in SeekDB, which encrypts a plaintext string and returns its hashed value, commonly used for securing credentials.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1100.uncompress.md", "description": "This document describes the `UNCOMPRESS` SQL function in SeekDB, which decompresses a string previously compressed with the `COMPRESS()` function, and includes syntax, description, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1200.uncompressed-length.md", "description": "This document describes the `UNCOMPRESSED_LENGTH` SQL function, which returns the original length of a string before it was compressed using the `COMPRESS()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1300.random-bytes.md", "description": "This document describes the `RANDOM_BYTES` SQL function in SeekDB, which generates a random binary string of a specified length between 1 and 1024 bytes, commonly used for cryptographic or unique identifier purposes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1400.sha.md", "description": "This document describes the `SHA()` SQL function in SeekDB, which computes the 160-bit SHA-1 hash of a given string and returns it as a 40-character hexadecimal string, equivalent to the `SHA1()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1500.sha1.md", "description": "This document describes the `SHA1` SQL function in SeekDB, which computes the SHA-1 160-bit checksum of a given string and returns it as a 40-character hexadecimal string, equivalent to the `SHA()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1600.sha2.md", "description": "This document describes the `SHA2` SQL function in SeekDB, which computes SHA-2 family hash values (SHA-224, SHA-256, SHA-384, SHA-512) for a given input string and specified output length.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1700.validate-password-strength.md", "description": "This document describes the `VALIDATE_PASSWORD_STRENGTH` SQL function, which evaluates the strength of a given password string and returns an integer score from 0 (weak) to 100 (strong), based on system password policy settings.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1800.sm3.md", "description": "This document describes the `SM3` function in SeekDB, a cryptographic hash function standardized by the Chinese National Cryptography Administration that returns a 32-character hexadecimal string.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/200.aes-encrypt.md", "description": "This document describes the `AES_ENCRYPT` SQL function in SeekDB, which encrypts a string using the AES algorithm with support for key lengths of 128, 192, or 256 bits and various block encryption modes (e.g., ECB, CBC). It covers syntax, behavior, initialization vector requirements, and usage examples alongside `AES_DECRYPT`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/300.compress.md", "description": "This document describes the `COMPRESS` SQL function, which compresses a string into a binary format and can be paired with the `UNCOMPRESS` function for decompression.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/400.decode.md", "description": "This document describes the `DECODE` SQL function in SeekDB, which decrypts an encrypted string using a provided password, and includes syntax, description, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/500.des-decrypt.md", "description": "This document describes the `DES_DECRYPT` SQL function in SeekDB, which decrypts strings encrypted with `DES_ENCRYPT`, requires SSL support, and optionally uses a provided key or reads from a DES key file with SUPER privilege.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/600.des-encrypt.md", "description": "This document describes the `DES_ENCRYPT` function in seekdb, including its syntax, usage, key management via a DES key file, output format, and an example—note that it requires SSL support and currently uses MySQL 8.0's default DES keys.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/700.encode.md", "description": "This document describes the `ENCODE()` SQL function in SeekDB, which encrypts a string using a passphrase and returns a binary string of the same length, intended to be decrypted with `DECODE()`. It includes syntax, usage notes emphasizing the use of a salt for security, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/800.encrypt.md", "description": "This document describes the `ENCRYPT()` SQL function in SeekDB, which uses the Unix `crypt()` system call to encrypt a string with an optional salt parameter, returning a binary string; it includes syntax, usage notes, character set limitations, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/100.benchmark.md", "description": "This document describes the `BENCHMARK()` SQL function, which executes a scalar expression a specified number of times to measure client-side performance. It includes syntax, behavior with invalid inputs, and an example using `AES_ENCRYPT`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1000.icu-version.md", "description": "This document describes the `ICU_VERSION()` SQL function in seekdb, which returns the version of the ICU (International Components for Unicode) library used for Unicode-safe regular expression operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1050.ob_transaction_id.md", "description": "This document describes the `OB_TRANSACTION_ID()` information function in OceanBase Database, which returns the current transaction ID if a transaction is active, or 0 otherwise.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1100.row-count.md", "description": "This document describes the `ROW_COUNT()` information function in SeekDB SQL, which returns the number of rows affected by the most recently executed SQL statement, with behavior varying by statement type (e.g., DDL, DML, or SELECT).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1200.schema.md", "description": "This document describes the `SCHEMA()` SQL function in SeekDB, which returns the name of the current schema and is synonymous with `DATABASE()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1300.session-user.md", "description": "This document describes the `SESSION_USER()` SQL function in SeekDB, which returns the current user's username and hostname in the utf8mb4 character set and is synonymous with `USER()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1400.system-user.md", "description": "This document describes the `SYSTEM_USER()` SQL function, which returns the current username and hostname and is synonymous with the `USER()` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1500.user.md", "description": "This document describes the `USER()` information function in SeekDB, which returns the current user's username and hostname as a utf8mb4-encoded string.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1600.version.md", "description": "This document describes the `VERSION()` information function in seekdb, which returns the database version string compatible with MySQL, including the seekdb-specific version number in the utf8mb4 character set.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/200.charset.md", "description": "This document describes the `CHARSET` SQL function in OceanBase, which returns the character set of a given string, with examples demonstrating its usage on UTF-8 and binary-encoded strings.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/300.coercibility.md", "description": "This document describes the `COERCIBILITY` function in seekdb, which returns the collation priority of a string used during multibyte sorting and comparison operations involving different character sets or collations. It explains coercibility values, their precedence rules, and provides examples for various input types.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/400.collation-info.md", "description": "This document describes the `COLLATION` information function in SeekDB SQL, which returns the collation of a given string expression, with examples demonstrating its usage and output.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/500.connection-id.md", "description": "This document describes the `CONNECTION_ID()` SQL function in SeekDB, which returns the unique Client Session ID for the current session, along with usage syntax and an example query.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/550.current-role.md", "description": "This document describes the `CURRENT_ROLE()` SQL function in SeekDB, which returns the activated role(s) of the current user in the session, or `NONE` if no role is active.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/600.current-user.md", "description": "This document describes the `CURRENT_USER()` information function in seekdb, which returns the authenticated login account name (username and hostname combination) using the utf8mb4 character set, reflecting the effective user context for privilege checking.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/700.database.md", "description": "This document describes the `DATABASE()` information function in SQL, which returns the name of the current database in the utf8mb4 character set or NULL if no database is selected.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/800.found-rows.md", "description": "This document describes the `FOUND_ROWS()` information function and its use with `SQL_CALC_FOUND_ROWS` in `SELECT` statements to retrieve the total number of rows that would have been returned without a `LIMIT` clause, commonly used for pagination and result set metadata.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/900.last-insert-id.md", "description": "This document describes the `LAST_INSERT_ID()` SQL function, which returns the auto-increment value generated for the first row inserted in the most recent `INSERT` statement within the current session.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/910.last-insert-id-behavior-description.md", "description": "This document explains the behavior of the `LAST_INSERT_ID()` function in seekdb, highlighting its compatibility with MySQL and key differences—particularly how seekdb updates `LAST_INSERT_ID` when an AUTO_INCREMENT column is manually specified in INSERT statements, unlike MySQL which leaves it unchanged.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/100.create-json-text-function/100.json-array.md", "description": "This document describes the `JSON_ARRAY` SQL function, which constructs a JSON array from a list of input values, supporting scalars, NULLs, and even JSON-formatted strings, with examples showing its usage and output.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/100.create-json-text-function/200.json-object.md", "description": "This document describes the `JSON_OBJECT` SQL function, which constructs a JSON object from a list of key-value pairs, requiring an even number of arguments and returning an empty object when called with no parameters.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/100.create-json-text-function/300.json-quote.md", "description": "This document describes the `JSON_QUOTE` SQL function, which returns a string as a properly escaped JSON string literal wrapped in double quotes, useful for generating valid JSON values from raw strings.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/100.json-contains.md", "description": "This document describes the `JSON_CONTAINS` function in SeekDB, which checks whether a specified JSON value exists within a target JSON document or at a given path, returning 1 if found and 0 otherwise. It includes syntax, behavior rules for scalars, arrays, and objects, error conditions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/200.json-contains-path.md", "description": "This document describes the `JSON_CONTAINS_PATH` SQL function, which checks whether specified JSON paths exist in a given JSON document, supporting both 'one' (any path exists) and 'all' (all paths exist) evaluation modes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/300.json-extract.md", "description": "This document describes the `JSON_EXTRACT` SQL function, which retrieves data from specified paths within a JSON document, returning `NULL` for invalid inputs or unmatched paths, and supports examples of array indexing, nested object access, and handling of special key names.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/400.json-keys.md", "description": "This document describes the `JSON_KEYS` function in SeekDB, which extracts and returns an array of top-level keys from a JSON object or a specified path within the JSON document, with details on syntax, behavior, error conditions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/500.json-overlaps.md", "description": "This document describes the `JSON_OVERLAPS` SQL function, which checks whether two JSON documents share any common key-value pairs or array elements, returning 1 if they do and 0 otherwise. It supports use cases like partial matching in JSON arrays and can be optimized with multi-value indexes on InnoDB tables.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/600.json-search.md", "description": "This document describes the `JSON_SEARCH` function in SeekDB, which locates and returns the path(s) of a specified string within a JSON document using pattern matching similar to SQL's `LIKE` operator. It covers syntax, parameters (including wildcard support with `%` and `_`, escape characters, and path filtering), behavior for `'one'` vs `'all'` search modes, error conditions, and practical examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/700.json-value.md", "description": "This document describes the `JSON_VALUE` SQL function, which extracts a scalar value from a JSON document at a specified path and optionally converts it to a desired data type, with configurable error and empty-value handling.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/800.member-of.md", "description": "This document describes the `MEMBER OF` JSON function in SeekDB, which checks if a specified scalar or JSON value exists as an element in a JSON array, returning 1 if found and 0 otherwise. It includes syntax details and examples demonstrating usage with scalars, strings, and nested JSON arrays.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/100.json-array-append.md", "description": "This document describes the `JSON_ARRAY_APPEND` SQL function, which appends values to specified arrays within a JSON document, including syntax, behavior with scalar or object targets, path evaluation rules, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/1000.json-unquote.md", "description": "This document describes the `JSON_UNQUOTE` function in SeekDB, which removes quotes from a JSON string value and returns it as a utf8mb4 string, with examples and behavior for valid and invalid inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/120.json-append.md", "description": "This document describes the `JSON_APPEND` function, an alias for `JSON_ARRAY_APPEND`, which appends values to JSON arrays at specified paths and handles scalar or object targets by wrapping them in arrays.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/200.json-array-insert.md", "description": "This document describes the `JSON_ARRAY_INSERT` SQL function, which inserts values into specified positions within JSON arrays and returns the modified JSON document, supporting multiple path-value pairs evaluated left to right.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/300.json-insert.md", "description": "This document describes the `JSON_INSERT` function in SeekDB, which inserts new key-value pairs into a JSON document without overwriting existing values, supporting multiple path-value arguments and handling arrays and objects according to specified path expressions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/400.json-merge.md", "description": "This document describes the `JSON_MERGE` function in SeekDB, which combines multiple JSON documents into a single JSON value, preserving duplicate keys and array elements—equivalent to `JSON_MERGE_PRESERVE()`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/500.json-merge-patch.md", "description": "This document describes the `JSON_MERGE_PATCH` SQL function, which merges two or more JSON documents according to RFC 7396, replacing values from the first document with those from subsequent ones and removing keys with null values in the latter.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/600.json-merge-preserve.md", "description": "This document describes the `JSON_MERGE_PRESERVE` SQL function, which merges two or more JSON documents by combining arrays, merging objects, and preserving duplicate keys as arrays.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/700.json-remove.md", "description": "This document describes the `JSON_REMOVE` function in SeekDB, which removes specified elements from a JSON document using path expressions and returns the modified JSON. It covers syntax, behavior with invalid inputs or non-existent paths, and includes usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/800.json-replace.md", "description": "This document describes the `JSON_REPLACE` function in SeekDB, which updates existing values in a JSON document by specifying path-value pairs, ignoring paths that do not already exist.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/900.json-set.md", "description": "This document describes the `JSON_SET` function in SeekDB, which inserts or updates data in a JSON document using specified path-value pairs and returns the modified JSON. It covers syntax, behavior for valid and invalid inputs, handling of arrays and objects, and includes a practical SQL example.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/100.json-depth.md", "description": "This document describes the `JSON_DEPTH` function in SeekDB, which returns the maximum nesting depth of a JSON document, with examples illustrating its behavior for scalars, arrays, and objects.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/200.json-length.md", "description": "This document describes the `JSON_LENGTH` function in SeekDB, which returns the number of elements in a JSON array, members in a JSON object, or 1 for a scalar value, optionally at a specified path within the JSON document.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/300.json-type.md", "description": "This document describes the `JSON_TYPE` function in SeekDB, which returns a UTF8MB4 string indicating the type of a JSON value (e.g., ARRAY, INTEGER, BOOLEAN), and includes syntax, behavior for NULL or invalid inputs, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/400.json-valid.md", "description": "This document describes the `JSON_VALID` function in SeekDB, which checks whether a given input value is valid JSON and returns 1 if true, 0 if false, or NULL if the input is NULL.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/450.json-table-functions.md", "description": "This document describes the `JSON_TABLE()` function in SeekDB, which converts semi-structured JSON data into relational tables by extracting values via JSON paths, supporting nested structures, error handling, and integration with SQL queries, views, and inserts.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/500.json-utility-function/100.json-pretty.md", "description": "This document describes the `JSON_PRETTY` function in SeekDB, which formats JSON values for readable output by adding indentation and line breaks according to standard JSON formatting rules.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/500.json-utility-function/200.json-storage-size.md", "description": "This document describes the `JSON_STORAGE_SIZE` function, which returns the binary storage size in bytes of a JSON document, useful for analyzing or optimizing JSON data storage in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/600.json-aggregate-function/100.json-arrayagg.md", "description": "This document describes the `JSON_ARRAYAGG` SQL function in SeekDB, which aggregates column values into a JSON array, with usage examples and syntax details.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/600.json-aggregate-function/200.json-objectagg.md", "description": "This document describes the `JSON_OBJECTAGG` aggregate function in SeekDB, which constructs a JSON object from key-value pairs derived from two input columns or expressions, handling duplicate keys by retaining the last encountered value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/700.json-schema-function/100.json-schema-valid.md", "description": "This document describes the `JSON_SCHEMA_VALID` SQL function, which validates a JSON document against a specified JSON Schema and returns 1 if valid or 0 otherwise, supporting use in column constraints and schema validation with attributes like `type`, `required`, and `$schema`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/700.json-schema-function/200.json-schema-validation-report.md", "description": "This document describes the `JSON_SCHEMA_VALIDATION_REPORT` SQL function, which returns a detailed JSON-formatted validation report indicating whether a JSON document conforms to a specified JSON schema, including failure reasons, locations, and violated keywords when validation fails.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/90.json-functions-overview.md", "description": "This document provides an overview of all JSON functions supported by seekdb, including functions for creating, modifying, searching, and validating JSON data, as well as aggregate and utility operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/750.xml-functions/100.xml-functions-overview.md", "description": "This document provides an overview of XML functions in seekdb, including EXTRACTVALUE for retrieving text nodes via XPath and UPDATEXML for modifying XML content at specified paths.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/750.xml-functions/300.querying-xmltype-data-functions/100.extractvalue-function.md", "description": "This document describes the `EXTRACTVALUE` function in SQL, which extracts values from an XML string using an XPath expression and returns them as a space-separated `LONGTEXT` string.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/750.xml-functions/400.modify-xmltype-data-functions/100.updatexml-function.md", "description": "This document describes the `UPDATEXML` function in SeekDB, which updates an XML string by replacing a node specified via XPath with a new XML fragment, returning the modified XML as a LONGTEXT.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/100.spatial-functions-overview.md", "description": "This document provides an overview of seekdb's spatial functions, which enable GIS and spatial data applications to perform geometry creation, spatial operations, relationship checks, attribute extraction, format conversion, and advanced spatial analysis directly within the database.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/1000.spatial-processing-function.md", "description": "This document describes the `_ST_MakeValid()` spatial processing function in seekdb, which repairs invalid geometries (e.g., self-intersecting polygons) by converting them into valid representations, supporting only projected coordinate systems and not geographic ones.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/1100.spatial-geohash-function.md", "description": "This document describes the `_ST_GeoHash` spatial function in SeekDB, which converts a geometry object into a GeoHash string representation with optional precision control, enabling approximate geographic encoding for points and other geometries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/150.create-a-geometry-function.md", "description": "This document describes seekdb's spatial functions for creating geometry objects from Well-Known Text (WKT), Well-Known Binary (WKB), or coordinate values, including `ST_GeomFromText`, `ST_GeomFromWKB`, and `_ST_MakePoint`, with details on syntax, parameters, SRID handling, and axis order options.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/200.spatial-operation-functions.md", "description": "This document describes seekdb's spatial operation functions, including `ST_Buffer()`, `ST_Buffer_Strategy()`, `ST_Transform()`, `ST_Difference()`, `ST_Union()`, `ST_SymDifference()`, and `_ST_ClipByBox2D()`, which are used to generate and manipulate geometric data in SQL queries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/300.spatial-relation-functions.md", "description": "This document describes seekdb's spatial relationship functions—such as `ST_Intersects()`, `ST_Contains()`, `ST_Distance()`, `ST_Distance_Sphere()`, `ST_Within()`, `ST_Crosses()`, `ST_Overlaps()`, `_ST_Touches()`, and `ST_Equals()`—which evaluate geometric relationships between two spatial objects, returning 1 for true, 0 for false, or a distance value where applicable.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/400.geometry-attribute-functions.md", "description": "This document describes seekdb's geometry attribute functions—`ST_Area`, `ST_SRID`, `ST_Latitude`, `ST_Longitude`, `ST_X`, and `ST_Y`—which retrieve or modify spatial properties like area, coordinate values, and spatial reference system identifiers for geometry objects.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/500.geometry-conversion-function.md", "description": "This document describes seekdb's geometry conversion functions—`ST_AsBinary()`, `ST_AsWKB()`, `ST_AsText()`, and `ST_AsWKT()`—which convert internal geometry values to WKB or WKT formats, with support for controlling coordinate axis order via optional parameters.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/600.spatial-analysis-function.md", "description": "This document describes seekdb's spatial analysis functions—`ST_Length()`, `ST_Centroid()`, and `_ST_PointOnSurface()`—used for geometric computations such as measuring line lengths with unit conversion, calculating centroids, and finding representative points on surfaces.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/700.spatial-constructor-function.md", "description": "This document describes the `_ST_MakeEnvelope` spatial constructor function in seekdb, which creates a rectangular bounding box geometry from specified corner coordinates and an optional SRID, commonly used for spatial queries and clipping operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/800.spatial-accessor-function.md", "description": "This document describes seekdb's spatial accessor functions—`_ST_GeometryType`, `_ST_IsCollection`, and `_ST_NumInteriorRings`—which extract metadata from geometry objects, such as geometry type, collection status, and number of interior rings in polygons.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/900.spatial-format-conversion-function.md", "description": "This document describes seekdb's spatial format conversion functions—`ST_AsGeoJSON`, `_ST_AsMVT`, and `ST_AsMVTGeom`—which convert geometry objects to standard geospatial formats like GeoJSON and Mapbox Vector Tiles (MVT), with detailed syntax, parameters, and usage examples for `ST_AsGeoJSON`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/900.performance-schema/100.format-bytes.md", "description": "This document describes the `FORMAT_BYTES` SQL function, which converts a byte count into a human-readable string with appropriate binary unit prefixes (e.g., KiB, MiB, GiB), rounding to two decimal places while preserving at least three significant digits.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/900.performance-schema/200.format-pico-time.md", "description": "This document describes the `FORMAT_PICO_TIME()` SQL function, which converts a time value in picoseconds into a human-readable string with an appropriate unit identifier (e.g., ps, ns, us, ms, s, min, h, d) based on the magnitude of the input.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/100.lock-functions-overview.md", "description": "This document provides an overview of seekdb's lock functions, including GET_LOCK, IS_FREE_LOCK, IS_USED_LOCK, RELEASE_ALL_LOCKS, and RELEASE_LOCK, which enable session-level named locking for coordination and concurrency control.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/200.get-lock.md", "description": "This document describes the `GET_LOCK` SQL function, which acquires a named lock with a specified timeout, blocking other sessions until the lock is released or the timeout expires. It covers syntax, parameters, return values, and usage examples for managing session-level locks in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/300.is-free-lock.md", "description": "This document describes the `IS_FREE_LOCK` SQL function, which checks whether a named lock is currently free (not held by any session), returning 1 if free and 0 otherwise. It includes syntax, parameters, return values, usage examples, and a reference to the related `IS_USED_LOCK` function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/400.is-used-lock.md", "description": "This document describes the `IS_USED_LOCK` SQL function in OceanBase Database, which checks if a named lock is currently held by any session and returns the session ID if it is, or `NULL` otherwise. It includes syntax, parameters, return values, usage examples, and a reference to the `GV$OB_PROCESSLIST` view for retrieving session details.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/500.release-all-locks.md", "description": "This document describes the `RELEASE_ALL_LOCKS()` SQL function in SeekDB, which releases all named locks held by the current session and returns the count of successfully released locks.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/600.release-lock.md", "description": "This document describes the `RELEASE_LOCK` SQL function in SeekDB, which releases a named lock previously acquired by the current session via `GET_LOCK()`, returning 1 on success, 0 if the session doesn't hold the lock, or NULL if the lock doesn't exist.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/100.roaring-bitmap-functions-overview.md", "description": "This document provides an overview of Roaring bitmap functions in seekdb, including constructor, cardinality, operation, decision, output, and aggregate functions for efficient storage and analysis of compressed bitmap data in use cases like user behavior analytics and audience targeting.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/200.roaring-bitmap-constructor-functions.md", "description": "This document describes RoaringBitmap constructor functions in seekdb, including `rb_build()`, `rb_build_empty()`, `rb_build_varbinary()`, and `rb_from_string()`, which create RoaringBitmap objects from arrays, empty instances, binary strings, or comma-separated value strings, along with usage examples and data type constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/300.roaring-bitmap-cardinality-calculation-functions.md", "description": "This document describes SeekDB's Roaring Bitmap cardinality calculation functions, including `rb_cardinality()`, bitwise operations like `rb_and_cardinality()` and `rb_or_cardinality()`, their null-handling variants (e.g., `*_null2empty_cardinality`), and aggregate functions `rb_or_cardinality_agg()` and `rb_and_cardinality_agg()` for computing union and intersection cardinalities across bitmap columns.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/400.roaring-bitmap-operation-functions.md", "description": "This document describes SeekDB's Roaring bitmap operation functions, including `rb_and()`, `rb_or()`, `rb_xor()`, `rb_andnot()`, and their `_null2empty` variants, which perform set operations like intersection, union, XOR, and difference on bitmap data while handling NULL inputs.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/500.roaring-bitmap-decision-functions.md", "description": "This document describes SeekDB's bitmap decision functions, `rb_is_empty()` and `rb_contains()`, which return Boolean values to determine if a Roaring bitmap is empty or contains specific elements or another bitmap.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/600.roaring-bitmap-output-functions.md", "description": "This document describes SeekDB's bitmap output functions—`rb_to_varbinary()`, `rb_to_string()`, `rb_iterate()`, and `rb_to_array()`—which convert RoaringBitmap data into varbinary, comma-separated string, tabular, or array formats for querying and interoperability.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/700.roaring-bitmap-aggregate-functions.md", "description": "This document describes SeekDB's bitmap aggregate functions—`rb_build_agg()`, `rb_or_agg()`, and `rb_and_agg()`—used to aggregate numeric or bitmap data into compressed RoaringBitmap representations for efficient storage and set operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/100.array-functions-overview.md", "description": "This document provides an overview of array functions in seekdb, including constructor, decision, output, and manipulation functions, with descriptions and usage examples for each supported function.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/200.array-constructor-functions.md", "description": "This document describes seekdb's array constructor functions—`array()`, `rb_build()`, and the `[]` operator—for creating array and RoaringBitmap data types, including syntax, usage examples, and type constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/300.array-decision-functions.md", "description": "This document describes seekdb's array decision functions—`array_contains()`, `array_contains_all()`, and `array_overlaps()`—which evaluate Boolean conditions on array contents, along with the `ANY()` operator for element-wise comparisons.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/500.array-output-functions.md", "description": "This document describes the `array_to_string()` function in seekdb, which converts array data into a delimited string representation, with options to specify a delimiter and a symbol for NULL elements. It supports both flat and nested arrays, enabling formatted output of array contents for display or export purposes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/600.array-manipulation-functions.md", "description": "This document describes seekdb's array manipulation functions, including `array_append()`, `array_distinct()`, `array_remove()`, `cardinality()`, `element_at()`, `string_to_array()`, `array_agg()`, `unnest()`, `split()`, and `contains()`, which enable operations like adding, removing, deduplicating, and querying elements in arrays.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/960.text-processing-functions/200.tokenize.md", "description": "This document describes the `TOKENIZE` SQL function in SeekDB, which splits text into tokens using specified parsers (such as BENG, NGRAM, SPACE, or IK) and configurable JSON parameters for stopwords, case sensitivity, and output format.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/100.map-functions-overview.md", "description": "This document provides an overview of seekdb's map functions, including constructor, decision, and manipulation functions for working with map data types, along with supported operators like `{}` and `=`/`!=`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/200.map-constructor-functions.md", "description": "This document describes the `map()` function and `{}` operator for constructing map data types in seekdb SQL, including syntax, parameter requirements, type inference, key uniqueness behavior, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/300.map-decision-functions.md", "description": "This document describes the map decision functions in seekdb, specifically the `=` and `!=` operators used to compare two map-type values for equality, returning a Boolean result based on whether their keys and values are identical.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/600.map-manipulation-functions.md", "description": "This document describes the `map_keys()` and `map_values()` functions in seekdb, which extract keys or values from MAP data types as arrays, with syntax examples and usage in SQL queries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/990.sequence-function/100.nextval.md", "description": "This document describes the `NEXTVAL(SEQ)` function in MySQL-compatible syntax, which retrieves and increments the next value from a named sequence. It includes examples for creating sequences and using `NEXTVAL` in SELECT and INSERT statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/400.functions/990.sequence-function/200.currval.md", "description": "This document describes the `CURRVAL(SEQ)` function in SeekDB, which returns the current value of a specified sequence, and includes examples of creating a sequence, using `NEXTVAL` to generate new values, and retrieving the current sequence value with `CURRVAL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/100.overview-of-queries-and-subqueries.md", "description": "This document provides an overview of SQL queries and subqueries in seekdb, covering basic relational operations (selection, projection, join), core query components (SELECT, FROM, WHERE, ORDER BY, GROUP BY, LIMIT, HAVING), and syntax examples including support for DUAL tables and positional column references.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/200.subquery-of-syntax.md", "description": "This document explains SQL subquery syntax and usage in seekdb, covering correlated and noncorrelated subqueries, scalar and row subqueries, and comparison operators like `ANY`, `ALL`, `IN`, and `EXISTS`. It includes examples and notes on evaluation behavior and constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/300.connection.md", "description": "This document explains SQL connection (join) operations in SeekDB, including inner joins, outer joins (left, right, full), self-joins, semi-joins, and anti-joins, along with their syntax, use cases, and how semi/anti joins are implemented via subqueries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/400.full-text-query.md", "description": "This document describes the syntax and usage of full-text queries in seekdb using the `MATCH ... AGAINST` expression, including support for natural language and boolean search modes, boolean operators (`+`, `-`, parentheses), and vectorized query execution via optimizer hints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/100.general-syntax.md", "description": "This document describes the general SQL syntax used in SeekDB, covering constants (integers, decimals, strings, NULL, and storage sizes), character sets, collations, data types (numeric, temporal, string, and binary types), SQL object naming conventions, expressions, comments, and storage attributes such as block size, compression, PCTFREE, and tablet size.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1100.alter-compile.md", "description": "This document describes the `ALTER COMPILE` SQL statement in seekdb, which recompiles a stored procedure or function, including its syntax, required privileges, parameters like `reuse settings`, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1200.alter-database.md", "description": "This document describes the `ALTER DATABASE` SQL statement syntax and usage for modifying database properties such as character set, collation, and read-only/read-write mode in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1220.alter-external-table.md", "description": "This document describes the `ALTER EXTERNAL TABLE ... REFRESH` SQL statement used to manually update file-based data for external tables in OceanBase Database when automatic updates are not supported.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1250.alter-materialized-view-in-sql.md", "description": "This document describes the `ALTER MATERIALIZED VIEW` SQL statement in seekdb, including its syntax, privilege requirements, and supported actions such as setting refresh strategies (`INDIVIDUAL`, `INCONSISTENT`, `CONSISTENT`), scheduling refresh cycles with `START WITH` and `NEXT`, and configuring parallelism via `PARALLEL` or `NOPARALLEL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1251.alter-materialized-view-log-in-sql.md", "description": "This document describes the `ALTER MATERIALIZED VIEW LOG` SQL statement in SeekDB, including its syntax, required privileges, and supported actions such as modifying parallelism, configuring log purge intervals, and adjusting LOB inline storage thresholds.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1300.alter-outline.md", "description": "This document describes the `ALTER OUTLINE` SQL statement in SeekDB, used to add throttling rules or bind execution plans to existing outlines created with the `SQL_TEXT` option, including syntax, parameters, examples, and usage constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1400.alter-sequence.md", "description": "This document describes the `ALTER SEQUENCE` SQL statement in SeekDB, which modifies properties of an existing sequence such as increment, min/max values, cache size, cycling behavior, and ordering. It includes syntax, parameter details, usage examples, and privilege requirements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1600.alter-table.md", "description": "This document describes the `ALTER TABLE` SQL statement in SeekDB, which modifies an existing table's structure by adding, changing, or dropping columns, indexes, constraints, and partitions, along with detailed syntax and supported options.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1800.alter-user.md", "description": "This document describes the `ALTER USER` SQL statement in seekdb, which allows administrators to change user passwords, lock or unlock accounts, set default roles, and modify resource limits, requiring the `CREATE USER` privilege.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/1900.alter-view.md", "description": "This document describes the `ALTER VIEW` SQL statement in seekdb, including its syntax, required privileges, parameters, and usage examples for modifying an existing view's definition.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/200.universal-table-expression.md", "description": "This document describes Common Table Expressions (CTEs) in seekdb, including syntax, usage scenarios, and examples for both non-recursive and recursive CTEs, with details on the `WITH` clause, column naming, and limitations in recursive queries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2000.analyze.md", "description": "This document describes the `ANALYZE` SQL statement in SeekDB, which collects table and column statistics—such as histograms and partition-level data—for query optimization, supporting both basic and extended syntax when `enable_sql_extension` is enabled.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2040.cache-index.md", "description": "This document describes the `CACHE INDEX` SQL statement syntax for loading table indexes into a key cache to improve query performance, noting that the functionality is not yet implemented in the current version.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2050.create-concurrent_limiting_rule.md", "description": "This document describes the `CREATE CONCURRENT_LIMITING_RULE` SQL statement in seekdb, which creates a concurrency throttling rule to limit the number of concurrent executions of specific SQL statements based on database, table, user, SQL type, and optional keyword filters.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2100.create-database.md", "description": "This document describes the `CREATE DATABASE` SQL statement in seekdb, including its syntax, parameters (such as character set, collation, and read/write mode), privilege requirements, and usage examples. It also notes that `CREATE DATABASE` is equivalent to `CREATE SCHEMA`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2150.create-external-catalog.md", "description": "This document describes the `CREATE EXTERNAL CATALOG` SQL statement in seekdb, which enables connecting to external ODPS (MaxCompute) data sources by specifying connection properties such as access credentials, endpoints, project name, and optional compression or quota settings, allowing direct querying of external data without ingestion.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2200.create-external-table.md", "description": "This document describes the `CREATE EXTERNAL TABLE` SQL statement in SeekDB, which enables reading data from external storage (e.g., local files, OSS, S3, or ODPS) by defining table schema, file location, format (CSV, Parquet, ORC), and optional partitioning or auto-refresh settings. External tables are read-only and do not support constraints or indexes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2220.create-index.md", "description": "This document describes the `CREATE INDEX` SQL statement in seekdb, including syntax, supported index types (unique, non-unique, full-text, spatial), usage of tokenizer options for full-text indexes, index storage options like `STORING`, and related limitations and permissions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2250.create-materialized-views-in-sql.md", "description": "This document describes the `CREATE MATERIALIZED VIEW` SQL statement in seekdb, including syntax, parameters, refresh options, storage formats, and privilege requirements for creating materialized views that store precomputed query results for improved performance.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2251.create-materialized-views-log-in-sql.md", "description": "This document describes the `CREATE MATERIALIZED VIEW LOG` SQL statement in seekdb, which creates a log to track incremental changes on a base table for fast refresh of materialized views, including syntax, parameters, privilege requirements, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2300.create-outline.md", "description": "This document describes the `CREATE OUTLINE` SQL statement in seekdb, which allows binding execution plans using either `SQL_TEXT` or `SQL_ID`, with details on syntax, parameters, and usage examples for plan stability and performance tuning.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2350.create-format-outline.md", "description": "This document describes the `CREATE FORMAT OUTLINE` SQL statement in SeekDB, which creates fuzzy outlines for plan binding using either `FORMAT_SQL_TEXT` or `FORMAT_SQL_ID`, with details on syntax, parameters, matching rules, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2450.create-role.md", "description": "This document describes the `CREATE ROLE` SQL statement in seekdb, including its syntax, required privileges (such as `CREATE USER` or `CREATE ROLE`), behavior under read-only mode, usage of the `IF NOT EXISTS` clause, and examples for creating one or multiple roles. It also links to related guides on role management and permission assignment.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2500.create-sequence.md", "description": "This document describes the `CREATE SEQUENCE` SQL statement in SeekDB, including its syntax, parameters (such as `START WITH`, `INCREMENT BY`, `CACHE`, `CYCLE`, etc.), and usage examples for generating unique integer sequences.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2600.create-table.md", "description": "This document describes the `CREATE TABLE` SQL statement in SeekDB, including syntax for defining columns, constraints, indexes, partitioning, table options, and data ingestion via `CREATE TABLE AS SELECT`, with support for temporary tables, JSON indexing, full-text search, and advanced storage configurations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2800.create-user-of-syntax.md", "description": "This document describes the `CREATE USER` SQL statement syntax, parameters, and usage examples for creating new users in seekdb, including authentication methods, TLS requirements, and resource limits.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2900.create-view.md", "description": "This document describes the `CREATE VIEW` SQL statement in seekdb, including its syntax, parameters, permissions, limitations, and usage examples for defining updatable and read-only views with `WITH CHECK OPTION`, `LOCAL`, and `CASCADED` clauses.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/2960.create-event.md", "description": "This document describes the `CREATE EVENT` SQL statement in seekdb, which is used to define and schedule automated tasks that execute stored procedures or SQL statements at specified times or intervals, including syntax, privilege requirements, scheduling options, and usage considerations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/1300.merge.md", "description": "This document describes the `ALTER SYSTEM MERGE` statement in OceanBase Database, which is used to manually trigger or manage major and minor compactions at the system, instance, or partition (tablet) level, including syntax, parameters, usage considerations, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/1500.module-data.md", "description": "This document describes the `ALTER SYSTEM MODULE DATA` SQL statement in seekdb, which is used to load or check module features such as `REDIS`, `GIS`, and `TIMEZONE`, including syntax, parameters, privileges, limitations, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/2200.flush-plan-cache.md", "description": "This document describes the `ALTER SYSTEM FLUSH PLAN CACHE` SQL statement in SeekDB, which clears cached execution plans for specified SQL IDs and databases, with options to target local or global nodes.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/2600.parameter.md", "description": "This document describes the `ALTER SYSTEM SET/RESET PARAMETER` SQL statement in seekdb, including syntax, usage examples, permissions required, and considerations for dynamic versus restart-based parameter effectiveness.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/3200.refresh-of-syntax.md", "description": "This document describes the `ALTER SYSTEM FLUSH KVCACHE` statement in SeekDB, which clears the dynamic memory KVCache to refresh system caches.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/4100.throttle.md", "description": "This document describes the `ALTER SYSTEM THROTTLE` SQL statement in SeekDB, which enables or disables request throttling based on metrics like queue time, response time, or resource usage, with optional priority-based filtering to protect high-priority workloads.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/4600.wash-memory-fragmentation.md", "description": "This document describes the `ALTER SYSTEM WASH MEMORY FRAGMENTATION` SQL statement in SeekDB, which manually clears memory fragmentation by releasing idle memory blocks on a specified server instance, and is restricted to the `root` user.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3000.deallocate-prepare.md", "description": "This document describes the `DEALLOCATE PREPARE` SQL statement, which is used to deallocate (remove) a previously prepared statement by name, with syntax support for both `DEALLOCATE PREPARE` and `DROP PREPARE`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3200.delete.md", "description": "This document describes the `DELETE` SQL statement in SeekDB, covering its syntax for single-table and multi-table deletions, supported clauses (such as `WHERE`, `ORDER BY`, `LIMIT`, and `PARTITION`), privilege requirements, limitations (e.g., no deletion from subqueries), and usage examples with partitioned tables and conditional filtering.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3300.describe.md", "description": "This document describes the `DESCRIBE` SQL statement (also known as `EXPLAIN` or `DESC`) used to retrieve schema information for a table or specific column in SeekDB, including syntax, parameters, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3350.drop-catalog.md", "description": "This document describes the `DROP CATALOG` SQL statement in seekdb, including its syntax, required privileges, parameters, and usage examples for removing an external data catalog.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3360.drop-concurrent_limiting_rule.md", "description": "This document describes the `DROP CONCURRENT_LIMITING_RULE` SQL statement in seekdb, including its syntax, required privileges, and usage examples for removing concurrent limiting rules that control query execution concurrency.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3400.drop-database.md", "description": "This document describes the `DROP DATABASE` SQL statement syntax, parameters, and usage examples for deleting a database in SeekDB, including the optional `IF EXISTS` clause to prevent errors when the database does not exist.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3500.drop-index.md", "description": "This document describes the `DROP INDEX` SQL statement in SeekDB, including its syntax, parameters, and usage example for removing an index from a table to reduce maintenance overhead.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3550.drop-materialized-views-in-sql.md", "description": "This document describes the SQL syntax, privilege requirements, and usage of the `DROP MATERIALIZED VIEW` statement in seekdb, including options like `IF EXISTS`, database specification, and drop behavior (`RESTRICT` or `CASCADE`).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3551.drop-materialized-views-log-in-sql.md", "description": "This document describes the `DROP MATERIALIZED VIEW LOG` SQL statement in seekdb, including its syntax, required privileges, usage examples, and behavior when transactions are active on the base table.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3600.drop-outline.md", "description": "This document describes the `DROP OUTLINE` SQL statement in SeekDB, which is used to remove a specified outline by name.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3660.drop-role.md", "description": "This document describes the `DROP ROLE` SQL statement in seekdb, including its syntax, required privileges, limitations (such as mandatory roles and atomic multi-role drops), and usage examples for removing roles from the database.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3700.drop-table.md", "description": "This document describes the `DROP TABLE` SQL statement in seekdb, including its syntax, parameters (such as `TEMPORARY`, `IF EXISTS`, and `RESTRICT | CASCADE`), and usage examples for deleting one or more tables.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/3900.drop-sequence.md", "description": "This document describes the `DROP SEQUENCE` SQL statement in SeekDB, including its syntax, parameters (such as `IF EXISTS` and schema qualification), and usage examples for removing a sequence from the database.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/4000.drop-user.md", "description": "This document describes the `DROP USER` SQL statement in SeekDB, including its syntax, required privileges, usage notes, and examples for removing one or more database users.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/4100.drop-view.md", "description": "This document describes the `DROP VIEW` SQL statement in seekdb, including its syntax, required permissions, usage of `IF EXISTS`, and behavior with dependent objects (currently unsupported).", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5200.execute.md", "description": "This document describes the `EXECUTE` SQL statement in SeekDB, which runs a previously prepared statement, optionally using user-defined variables to supply parameter values.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5300.explain.md", "description": "This document describes the `EXPLAIN` SQL statement in SeekDB, which displays the execution plan for DML operations like `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and `REPLACE`. It covers syntax options, output formats (including `TRADITIONAL` and `JSON`), plan detail levels (`BASIC`, `EXTENDED`, etc.), and how to save and retrieve plans using `INTO table_name` and `SET statement_id`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5400.flashback-database.md", "description": "This document describes the `FLASHBACK DATABASE/TABLE` SQL statement in SeekDB, which restores deleted database objects from the recycle bin, including syntax, parameters, usage examples, and behavior related to indexes and the `recyclebin` system variable.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5420.fork-table-in-sql.md", "description": "This document describes the `FORK TABLE` SQL statement in seekdb, which creates a logically independent, snapshot-consistent copy of a source table with optimized performance by reusing storage structures—ideal for use cases like data versioning, A/B testing, and sandboxing.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5450.flush-table.md", "description": "This document describes the `FLUSH TABLE` SQL statement in SeekDB, including its syntax, usage, and the hidden configuration `_enable_mock_stmt_flush_table` required to enable it, noting that the statement is syntactically supported but has no operational effect.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5500.grant.md", "description": "This document describes the `GRANT` SQL statement in seekdb, which is used to assign object privileges or roles to users and roles, including syntax, privilege requirements, limitations (such as no cyclic role grants), and examples for granting database, table, function, procedure, and catalog-level permissions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5600.help.md", "description": "This document describes the `HELP` SQL statement in SeekDB, which enables searching the built-in help system using wildcard-supported keywords to retrieve information on categories, data types, and specific SQL topics like `SELECT` or `KILL`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5700.insert-sql.md", "description": "This document describes the `INSERT` SQL statement in seekdb, including syntax, parameters, permissions, and usage examples for inserting data into tables—supporting explicit values, `SELECT`-based inserts, `ON DUPLICATE KEY UPDATE`, partition-specific inserts, and advanced features like direct load hints (`APPEND`, `DIRECT`) and `INSERT OVERWRITE`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5800.kill.md", "description": "This document describes the `KILL` SQL statement in OceanBase Database, which is used to terminate sessions or queries, including syntax, required privileges (`PROCESS` and `SUPER`), parameter details, and usage examples with `SHOW PROCESSLIST`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5900.load-data-of-syntax.md", "description": "This document describes the `LOAD DATA` SQL statement in seekdb, which imports data from server-side files, client-side local files, OSS, or URLs into database tables, supporting CSV, Parquet, and ORC formats with options for parallelism, direct load modes (`full`, `inc`, `inc_replace`), error handling, and partitioning.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/5950.load-index-into-cache.md", "description": "This document describes the `LOAD INDEX INTO CACHE` SQL statement, which is intended to preload specified table indexes into memory to enhance query performance, though its functionality is not yet effective in the current version.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/6000.lock-table.md", "description": "This document describes the `LOCK TABLES` SQL statement in seekdb, including its syntax, lock types (`READ`, `WRITE`), prerequisites (such as enabling `enable_lock_priority`), usage examples, limitations, and required privileges for controlling concurrent access to tables.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7000.optimize.md", "description": "This document describes the `OPTIMIZE TABLE` SQL statement in SeekDB, which initiates a progressive major compaction on specified tables based on the `progressive_merge_num` parameter.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7100.prepare.md", "description": "This document describes the `PREPARE` SQL statement in seekdb, which is used to create a named prepared statement for later execution with `EXECUTE`, including syntax, parameter details, supported SQL statements, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7200.purge-database.md", "description": "This document describes the `PURGE` SQL statement in SeekDB, which permanently deletes database objects—such as databases, tables, and indexes—from the recycle bin using their system-generated recycle bin names.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7300.purge-recyclebin.md", "description": "This document describes the `PURGE RECYCLEBIN` SQL statement, which permanently deletes all objects in the recycle bin and is restricted to root user execution.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7400.rename-user.md", "description": "This document describes the `RENAME USER` SQL statement in seekdb, which allows administrators with the `CREATE USER` privilege to change a login username while preserving associated permissions.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7500.rename-table.md", "description": "This document describes the `RENAME TABLE` SQL statement in OceanBase Database, including its syntax, required privileges, limitations, and usage examples for renaming or moving tables across databases.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7600.replace.md", "description": "This document describes the `REPLACE` SQL statement in OceanBase Database, which inserts new records or replaces existing ones by deleting conflicting rows based on primary or unique key constraints, with syntax, parameters, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7650.repalr-table.md", "description": "This document describes the `REPAIR TABLE` SQL statement syntax for repairing potentially damaged tables in SeekDB, noting that the feature is currently unsupported despite partial syntax availability.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7700.revoke.md", "description": "This document describes the `REVOKE` SQL statement in seekdb, which is used to remove previously granted privileges or roles from users or roles, including syntax, privilege requirements, limitations, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7800.savepoint.md", "description": "This document describes the `SAVEPOINT` SQL statement in SeekDB, including its syntax for creating, rolling back to, and releasing savepoints within a transaction, along with detailed examples of how savepoints enable partial rollbacks by tracking SQL statement order and partition involvement.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/7900.schema-sql.md", "description": "This document explains that `SCHEMA` is a synonym for `DATABASE` in SQL syntax and provides references to related statements: CREATE DATABASE, ALTER DATABASE, and DROP DATABASE.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8000.select-into.md", "description": "This document describes the `SELECT INTO` SQL statement in seekdb, which exports query results to files (including CSV, Parquet, and ORC formats) or variables, covering syntax, privilege requirements, file path specifications for local and OSS storage, formatting options, and partitioning support.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/100.select.md", "description": "This document describes the `SELECT` SQL statement in seekdb, including its syntax, parameters, permissions, and support for querying data from tables, external files (CSV, Parquet, ORC), and cloud sources like ODPS, along with clauses such as `JOIN`, `GROUP BY`, `WINDOW`, and `UNION`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/200.join-clause.md", "description": "This document describes the `JOIN` clause in seekdb SQL, including its syntax, supported join types (INNER, CROSS, LEFT, RIGHT, FULL, NATURAL), join conditions (`ON` and `USING`), table references, partitioning, sampling, index hints, and required permissions for execution.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/300.over-clause.md", "description": "This document describes the `WINDOW` clause in seekdb SQL, which defines named windows for analytic functions using `ROWS` or `RANGE` frame semantics, including syntax, parameters, and examples for partitioning, ordering, and window boundary specifications.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/400.union-clause.md", "description": "This document describes the `UNION` clause in seekdb SQL, which performs set operations—such as `UNION`, `UNION ALL`, `INTERSECT`, and `EXCEPT`/`MINUS`—on multiple `SELECT` queries, with details on syntax, usage constraints, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.set-default-role.md", "description": "This document describes the `SET DEFAULT ROLE` SQL statement in seekdb, which configures the default roles activated for a user upon login, including syntax, parameters, required privileges, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8200.set.md", "description": "This document describes the `SET` SQL statement syntax and usage for assigning values to user-defined or system variables at session or global scope, including examples with literals, expressions, and subqueries.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8250.set-catalog.md", "description": "This document describes the `SET CATALOG` SQL statement in seekdb, which is used to switch between the internal catalog and external data catalogs, including syntax, required privileges (`USE CATALOG`), and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8300.set-charset.md", "description": "This document describes the `SET CHARSET` SQL statement in SeekDB, which configures the client and result character set to support encodings like `utf8`, `utf8mb4`, `gbk`, `utf16`, and `gb18030`, with examples and syntax details.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8400.set-names.md", "description": "This document describes the `SET NAMES` SQL statement in SeekDB, which configures the client, connection, and result character sets and collations, supporting character sets like `utf8mb4`, `gbk`, and `gb18030` with corresponding collations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8500.set-password.md", "description": "This document describes the `SET PASSWORD` SQL statement in SeekDB, which allows users to change their own password or another user's password (with appropriate privileges), using either a plaintext password or a pre-hashed value.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8550.set-role.md", "description": "This document describes the `SET ROLE` SQL statement in SeekDB, which activates specific roles for the current session, including syntax, parameters like `DEFAULT`, `NONE`, `ALL`, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8600.set-transaction.md", "description": "This document describes the `SET TRANSACTION` SQL statement in seekdb, which configures transaction isolation levels (Read Committed, Repeatable Read, or Serializable) and access modes (READ ONLY or READ WRITE) at the transaction, session, or global level, with usage constraints and examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8700.show.md", "description": "This document describes the `SHOW` SQL statement in seekdb, which is used to retrieve metadata and runtime information about database objects such as tables, columns, indexes, procedures, functions, variables, status, privileges, and more. It includes syntax details, supported clauses (like `LIKE` and `WHERE`), and explanations of each variant's output and usage.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8750.submit-job.md", "description": "This document describes the `SUBMIT JOB` SQL statement in SeekDB, which enables asynchronous execution of supported data import operations like `INSERT INTO SELECT`, `INSERT OVERWRITE`, `CREATE TABLE AS SELECT`, and `LOAD DATA INFILE` to handle large data volumes reliably.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8760.show-job-status.md", "description": "This document describes the `SHOW JOB STATUS` SQL statement in SeekDB, which allows users to query the status of asynchronous tasks, including details such as job ID, database schema, execution status, error messages, timestamps, and the original SQL definition. It covers syntax, parameters, user permissions, and examples for viewing all jobs or a specific job by ID.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8770.cancel-job.md", "description": "This document describes the `CANCEL JOB` SQL statement in SeekDB, which terminates an asynchronous task by its job ID, including syntax, behavior for running/completed tasks, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8800.transaction.md", "description": "This document describes the SQL `TRANSACTION` statement in SeekDB, including syntax and usage for `START TRANSACTION`, `BEGIN`, `COMMIT`, `ROLLBACK`, and `SET TRANSACTION`, with examples demonstrating how to manage explicit transactions to ensure data integrity.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8900.truncate-table.md", "description": "This document describes the `TRUNCATE TABLE` SQL statement in seekdb, which efficiently empties a table while preserving its structure and partitioning, including syntax, privileges, limitations, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/8950.unlock-tables.md", "description": "This document describes the `UNLOCK TABLES` SQL statement in SeekDB, which releases all table locks held by the current session without committing transactions, and includes syntax, usage examples, and a reference to `LOCK TABLES`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/9000.update.md", "description": "This document describes the `UPDATE` SQL statement in seekdb, including its syntax, parameters, limitations (such as unsupported subquery updates), required privileges, and usage examples for updating data in single or multiple tables, with support for partition-specific updates, conditional filtering via `WHERE`, row ordering with `ORDER BY`, and limiting the number of updated rows using `LIMIT`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/9100.use.md", "description": "This document describes the SQL `USE` statement syntax and usage for switching to a specified database in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/600.sql-statement/9200.value.md", "description": "This document describes the `VALUES` SQL statement in SeekDB, a table-value constructor used to return one or more rows of data as a virtual table, supporting use with `UNION`, `EXCEPT`, `INTERSECT`, `ORDER BY`, and `LIMIT`.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/100.ddl-function-overview.md", "description": "This document provides an overview of supported DDL (Data Definition Language) features in SeekDB, including index, primary key, column, generated column, foreign key, table, and partition operations.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/150.online-and-offline-ddl-list.md", "description": "This document lists and compares online and offline DDL operations in SeekDB, detailing their definitions, characteristics, transactional behavior, and support status for various schema changes—including index, column, table, constraint, and partition operations—with notes on performance impact and materialized view log compatibility.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/200.index-operations.md", "description": "This document describes index operations in SeekDB, including how to create (via `CREATE INDEX` or `CREATE TABLE`), view (`SHOW INDEX`), add (`ALTER TABLE ... ADD INDEX`), drop (`DROP INDEX` or `ALTER TABLE ... DROP INDEX`), and rename indexes, with syntax details, parameter explanations, and examples for each operation.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/300.primary-key-operations.md", "description": "This document explains how to perform primary key operations in SeekDB, including adding, modifying, and dropping primary keys using `ALTER TABLE` SQL syntax.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/400.column-operations.md", "description": "This document describes seekdb's column operations, including adding columns (at the end or specific positions), dropping single or multiple columns, renaming, reordering, changing data types, managing defaults and constraints, and modifying auto-increment values using `ALTER TABLE` syntax.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/500.generated-column-operations.md", "description": "This document describes SQL syntax for managing generated columns in seekdb, including adding, modifying, and dropping `STORED` and `VIRTUAL` columns using `ALTER TABLE` statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/600.foreign-key-operations.md", "description": "This document describes how to add and drop foreign key constraints in seekdb using `ALTER TABLE` statements, including syntax and examples for defining referential integrity between tables.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/700.table-operations.md", "description": "This document describes table operations in seekdb, including modifying row format, block size, character set, and renaming tables using `ALTER TABLE` statements.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/800.partitioning-operations.md", "description": "This document describes partitioning operations in SeekDB, including repartitioning tables, adding, dropping, and truncating partitions with SQL syntax and examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/900.column-type-change-rule.md", "description": "This document outlines the column type change rules in seekdb, covering table-level constraints (such as foreign keys, CHECK constraints, and triggers), Online/Offline DDL considerations, and detailed data type conversion rules within and across numeric, character, and time data type categories.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/700.ddl-function/950.number-type-change-rule.md", "description": "This document outlines the NUMBER type conversion rules in seekdb, detailing supported conversions between fixed-point, unsigned fixed-point, and floating-point number types based on precision and scale constraints.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/800.overview-of-pseudo-columns/100.overview-of-pseudo-columns.md", "description": "This document provides an overview of pseudo columns in seekdb, which behave like table columns but are read-only and do not store actual data, including details on supported types such as PARTITIONID and Sequence.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/800.overview-of-pseudo-columns/200.partititionid-pseudo-column.md", "description": "This document describes the `PARTITIONID` pseudo column in OceanBase Database, which allows querying partition metadata such as ID, index, and name for both partitioned and subpartitioned tables, along with usage syntax, limitations, naming conflicts, and how to disable the feature via system configuration.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/100.sql-syntax/800.overview-of-pseudo-columns/300.sequence-pseudo-column.md", "description": "This document explains how to use sequence pseudo columns (`CURRVAL` and `NEXTVAL`) in SQL to generate incrementing numeric values, commonly used for primary or unique keys, including syntax, usage scenarios, limitations, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/200.sql/90.sql-overview.md", "description": "This document provides an overview of SQL in the context of seekdb, covering its history, standards (with emphasis on SQL-92 compliance), core components (DQL, DML, TCL, DCL, DDL), portability across relational databases, and formatting conventions used in the documentation.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/100.basic-syntax.md", "description": "This document describes the basic syntax of stored programs in seekdb, including `BEGIN ... END` blocks, `DECLARE` statements for variables and cursors, and the use of statement labels with control flow structures like `LOOP`, `REPEAT`, and `WHILE`.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/100.what-is-pl/100.pl-introduction.md", "description": "This document introduces PL (Procedural Language), an extension of SQL that adds programming capabilities like logic control and loops, enabling high-performance, secure, and portable database-side business logic execution in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/100.what-is-pl/200.main-functions-of-pl.md", "description": "This document describes the main features and functions of seekdb's Procedural Language (PL), including exception handling, PL blocks, variables and constants, packages, triggers, input/output operations, data abstraction (cursors, composite variables, %ROWTYPE, %TYPE, abstract data types), control statements, and bulk query result processing.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/100.what-is-pl/300.pl-architecture.md", "description": "This document describes the architecture of SeekDB's PL (Procedural Language) engine, detailing its six core modules—Parser, Resolver, Code Generator, Compiler, Executor, and PL Cache—and how it interacts with the SQL engine via SPI for executing user-defined functions and SQL statements.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/100.system-package-overview.md", "description": "This document provides an overview of PL system packages in seekdb, including their structure, usage, and a list of supported packages such as DBMS_STATS, DBMS_RESOURCE_MANAGER, and DBMS_VECTOR for extending database functionality.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/100.dbms-mview-stat-overview.md", "description": "This document provides an overview of the `DBMS_MVIEW_STATS` system package in seekdb, which manages the collection and retention of materialized view refresh statistics, including subprograms for purging stats, setting collection parameters, and configuring system defaults.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/200.purge-refresh-stats.md", "description": "This document describes the `PURGE_REFRESH_STATS` procedure in SeekDB, which forcibly deletes materialized view refresh statistics older than a specified retention period, supporting cleanup for a specific view or all views.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/300.set-mvref-stats-params.md", "description": "This document describes the `SET_MVREF_STATS_PARAMS` procedure in SeekDB, which configures the statistics collection level (NONE, TYPICAL, or ADVANCED) and retention period (1–365000 days or permanent) for materialized view refresh operations, with options to apply settings globally or to a specific materialized view.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/400.set-system-default.md", "description": "This document describes the `SET_SYSTEM_DEFAULT` procedure in SeekDB, which configures system-wide default values for materialized view refresh statistics parameters such as `COLLECTION_LEVEL` and `RETENTION_PERIOD`.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13200.dbms_partition/100.dbms_partition-overview.md", "description": "This document provides an overview of the `DBMS_PARTITION` system package in seekdb, which enables dynamic partition management through subprograms like `MANAGE_DYNAMIC_PARTITION` for automatically creating future partitions and dropping expired ones.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13200.dbms_partition/200.manage_dynamic_partition.md", "description": "This document describes the `MANAGE_DYNAMIC_PARTITION` procedure in SeekDB's `DBMS_PARTITION` system package, which automates the precreation of future partitions and deletion of expired partitions for dynamic partition tables, with options to specify precreation time and target time units (hour, day, week, month, year).", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/100.dbms-resource-manager-overview.md", "description": "This document provides an overview of the `DBMS_RESOURCE_MANAGER` package in seekdb, including required privileges and a list of supported subprograms for managing resource plans, consumer groups, and plan directives.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/200.create-consumer-group.md", "description": "This document describes the `CREATE_CONSUMER_GROUP` procedure in the `DBMS_RESOURCE_MANAGER` package, which creates a resource consumer group for database workload management, including its syntax, parameters, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/300.create-plan.md", "description": "This document describes the `CREATE_PLAN` procedure in the `DBMS_RESOURCE_MANAGER` package, which is used to define a new resource plan by specifying its name and an optional comment.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/400.create-plan-directive.md", "description": "This document describes the `CREATE_PLAN_DIRECTIVE` procedure in seekdb's `DBMS_RESOURCE_MANAGER` package, which defines resource allocation rules for CPU, I/O, and network bandwidth within a resource plan.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/500.delete-consume-group.md", "description": "This document describes the `DBMS_RESOURCE_MANAGER.DELETE_CONSUMER_GROUP` procedure, which deletes a specified consumer group in the database resource management system.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/600.delete-plan.md", "description": "This document describes the `DBMS_RESOURCE_MANAGER.DELETE_PLAN` procedure, which deletes a specified resource plan and all its associated plan directives in Oracle-compatible resource management systems.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/700.delete-plan-directive.md", "description": "This document describes the `DELETE_PLAN_DIRECTIVE` procedure in the `DBMS_RESOURCE_MANAGER` package, which removes a resource plan directive by specifying the plan name and the associated consumer group or subplan.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/800.set-consumer-group-mappingn-directive.md", "description": "This document describes the `SET_CONSUMER_GROUP_MAPPING` procedure in seekdb's DBMS_RESOURCE_MANAGER package, which maps database sessions to resource consumer groups based on attributes like USER, COLUMN, or FUNCTION—enabling fine-grained control over resource allocation for user sessions and background tasks such as compaction, DDL operations, and materialized view refreshes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/900.update-plan-directive.md", "description": "This document describes the `UPDATE_PLAN_DIRECTIVE` procedure in seekdb's `DBMS_RESOURCE_MANAGER` package, which modifies resource allocation settings—such as CPU limits, IOPS, and network bandwidth—for a specified consumer group or subplan within a resource plan.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/100.dbms-stats-overview.md", "description": "This document provides an overview of the `DBMS_STATS` system package in seekdb, which enables collection, modification, deletion, locking, and restoration of optimizer statistics for database objects such as tables, indexes, columns, schemas, and system-level statistics.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1000.drop-stat-table.md", "description": "This document describes the `DBMS_STATS.DROP_STAT_TABLE` procedure, which drops a user's statistics table in Oracle-compatible databases, including its syntax, parameters, required permissions, and usage example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1100.export-column-stats.md", "description": "This document describes the `EXPORT_COLUMN_STATS` procedure in the `DBMS_STATS` package, which exports column-level statistics from a specified table to a user-defined statistics table, including parameter details, usage notes, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1200.export-index-stats.md", "description": "This document describes the `EXPORT_INDEX_STATS` procedure in seekdb's `DBMS_STATS` package, which exports index statistics to a user-defined statistics table, including syntax, parameters, usage notes, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1300.export-table-stats.md", "description": "This document describes the `EXPORT_TABLE_STATS` procedure in the `DBMS_STATS` package, which exports table-level statistics—including column and partition statistics—to a user-defined statistics table for backup or migration purposes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1400.export-schema-stats.md", "description": "This document describes the `EXPORT_SCHEMA_STATS` procedure in the `DBMS_STATS` package, which exports statistics for all tables in a specified schema to a user-defined table, including syntax, parameters, usage notes, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1500.flush-database-monitoring-info.md", "description": "This document describes the `DBMS_STATS.FLUSH_DATABASE_MONITORING_INFO` procedure, which immediately refreshes in-memory monitoring data for all tables and indexes, updating the `*_TAB_STATISTICS` and `*_IND_STATISTICS` views without waiting for automatic refresh.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1600.gather-index-stats.md", "description": "This document describes the `DBMS_STATS.GATHER_INDEX_STATS` procedure in seekdb, which collects index statistics for query optimization, including syntax, parameters like `ownname`, `indname`, `estimate_percent`, and `granularity`, usage notes, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1700.gather-table-stats.md", "description": "This document describes the `GATHER_TABLE_STATS` procedure in seekdb's `DBMS_STATS` package, which collects table and column statistics to optimize query performance, detailing its syntax, parameters (including sampling, parallelism, granularity, and histogram options), usage notes, exceptions, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1800.gather-schema-stats.md", "description": "This document describes the `GATHER_SCHEMA_STATS` procedure in seekdb's `DBMS_STATS` package, which collects optimizer statistics for all objects in a specified schema, including parameters for sampling, parallelism, histogram collection, partition granularity, and cache invalidation.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1850.gather-system-stats.md", "description": "This document describes the `GATHER_SYSTEM_STATS` procedure in the `DBMS_STATS` package, which collects system-level performance statistics such as CPU speed, disk I/O, and network throughput for query optimization.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1900.get-stats-history-availability.md", "description": "This document describes the `GET_STATS_HISTORY_AVAILABILITY` function in the `DBMS_STATS` package, which returns the earliest timestamp of available historical statistics for use in query optimization and performance tuning.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/200.alter-stats-history-retention.md", "description": "This document describes the `ALTER_STATS_HISTORY_RETENTION` procedure in the `DBMS_STATS` system package, which modifies the retention period (in days) for historical statistics, with a default of 31 days.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2000.get-stats-history-retention.md", "description": "This document describes the `GET_STATS_HISTORY_RETENTION` function in the `DBMS_STATS` package, which returns the current retention period (in days) for historical statistics in the database.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2100.get-param.md", "description": "This document describes the `DBMS_STATS.GET_PARAM` function in the PL/SQL system package, which retrieves the default value of a specified parameter used by procedures in the `DBMS_STATS` package, such as `METHOD_OPT`.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2200.get-prefs.md", "description": "This document describes the `DBMS_STATS.GET_PREFS` function in SeekDB, which retrieves the default value of a specified statistics preference for a given user and table, including its syntax, parameters, exceptions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2300.import-index-stats.md", "description": "This document describes the `DBMS_STATS.IMPORT_INDEX_STATS` procedure in seekdb, which imports index statistics from a user-defined statistics table into the data dictionary, supporting parameters for schema, table, index, partition, and cache invalidation control.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2400.import-column-stats.md", "description": "This document describes the `IMPORT_COLUMN_STATS` procedure in the `DBMS_STATS` package, which imports column-level statistics from a user-defined statistics table into a specified table column, with options to handle partitioned tables, plan cache invalidation, and locked statistics.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2500.import-table-stats.md", "description": "This document describes the `DBMS_STATS.IMPORT_TABLE_STATS` procedure in SeekDB, which imports table-level statistics from a user-defined statistics table, supporting options for cascading to columns and indexes, handling partitioned tables, and overriding statistic locks.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2600.import-schema-stats.md", "description": "This document describes the `IMPORT_SCHEMA_STATS` procedure in the `DBMS_STATS` package, which imports schema-level statistics from a user-defined table into the data dictionary, including parameter details, usage notes, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2700.lock-partition-stats.md", "description": "This document describes the `LOCK_PARTITION_STATS` procedure in the `DBMS_STATS` package, which locks statistics for a specified table partition to prevent automatic updates, ensuring stable query execution plans.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2800.lock-schema-stats.md", "description": "This document describes the `LOCK_SCHEMA_STATS` procedure in the `DBMS_STATS` package, which locks statistics for all tables in a specified schema to prevent modifications via gather, set, delete, or import operations. It includes syntax, parameters, usage notes, and an example for locking schema-level statistics in PolarDB.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2900.lock-table-stats.md", "description": "This document describes the `LOCK_TABLE_STATS` procedure in the DBMS_STATS package, which locks table statistics to prevent modifications, including dependent objects like columns, indexes, and partitions. It covers syntax, parameters, usage notes, and an example for locking table-level statistics in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/300.create-stat-table.md", "description": "This document describes the `DBMS_STATS.CREATE_STAT_TABLE` procedure in SeekDB, which creates a user-defined table to store database statistics, including its syntax, parameters, exceptions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3000.restore-table-stats.md", "description": "This document describes the `DBMS_STATS.RESTORE_TABLE_STATS` procedure in SeekDB, which restores historical table-level statistics to a specified timestamp, including parameter details, usage requirements, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3100.restore-schema-stats.md", "description": "This document describes the `DBMS_STATS.RESTORE_SCHEMA_STATS` procedure, which restores historical schema-level statistics to a specified point in time, including its syntax, parameters, exceptions, usage requirements, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3200.reset-global-pref-defaults.md", "description": "This document describes the `DBMS_STATS.RESET_GLOBAL_PREF_DEFAULTS` procedure, which resets all global statistics preferences to their default values in TiDB.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3300.reset-param-defaults.md", "description": "This document describes the `DBMS_STATS.RESET_PARAM_DEFAULTS` procedure in seekdb, which resets all statistics collection parameter defaults to seekdb-recommended values.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3400.purge-stats.md", "description": "This document describes the `DBMS_STATS.PURGE_STATS` procedure, which deletes historical statistics older than a specified timestamp in SeekDB, including its syntax, parameters, exceptions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3500.set-column-stats.md", "description": "This document describes the `SET_COLUMN_STATS` procedure in seekdb's `DBMS_STATS` package, which allows users to manually set column-level statistics such as number of distinct values (NDV), density, null count, and average column length for query optimization purposes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3600.set-index-stats.md", "description": "This document describes the `DBMS_STATS.SET_INDEX_STATS` procedure in seekdb, which allows users to manually set index statistics such as row count, average row length, and block counts for query optimization purposes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3700.set-table-stats.md", "description": "This document describes the `DBMS_STATS.SET_TABLE_STATS` procedure in PL/SQL, which allows users to manually set table-level statistics such as row count, block count, and average row length for query optimization purposes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3800.set-global-prefs.md", "description": "This document describes the `DBMS_STATS.SET_GLOBAL_PREFS` procedure in SeekDB, which sets global statistics preferences using a name-value pair, including syntax, parameters, exceptions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3900.set-param.md", "description": "This document describes the `DBMS_STATS.SET_PARAM` procedure in SeekDB, which sets default parameter values for statistics collection procedures, including syntax, parameters, exceptions, usage notes, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/400.delete-column-stats.md", "description": "This document describes the `DBMS_STATS.DELETE_COLUMN_STATS` procedure in SeekDB, which deletes column-level statistics for a specified table column, with options to control partition handling, plan cache invalidation, force execution, and statistic type (e.g., 'ALL' or 'HISTOGRAM').", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4000.set-schema-prefs.md", "description": "This document describes the `DBMS_STATS.SET_SCHEMA_PREFS` procedure, which sets statistics preferences for a specified schema in SeekDB, including its syntax, parameters, exceptions, usage notes, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4050.set-system-stats.md", "description": "This document describes the `DBMS_STATS.SET_SYSTEM_STATS` procedure in SeekDB, which allows users to set system statistics such as CPU speed, disk sequential and random read speeds, and network speed for query optimization purposes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4100.set-table-prefs.md", "description": "This document describes the `DBMS_STATS.SET_TABLE_PREFS` procedure in SeekDB, which sets statistics preferences for a specified table, including parameter details, usage requirements, and an example for configuring the `DEGREE` preference.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4200.unlock-partition-stats.md", "description": "This document describes the `DBMS_STATS.UNLOCK_PARTITION_STATS` procedure in PL/SQL, which unlocks statistics for a specified table partition, including its syntax, parameters, usage requirements, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4300.unlock-schema-stats.md", "description": "This document describes the `UNLOCK_SCHEMA_STATS` procedure in the `DBMS_STATS` package, which unlocks statistics for all tables in a specified schema, allowing subsequent modifications to table, column, index, and histogram statistics.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4400.unlock-table-stats.md", "description": "This document describes the `DBMS_STATS.UNLOCK_TABLE_STATS` procedure, which unlocks table-level statistics in SeekDB, including details on syntax, parameters (`ownname`, `tabname`, `stattype`), usage restrictions, and examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4500.cancel-gather-status.md", "description": "This document describes the `CANCEL_GATHER_STATS` procedure in OceanBase Database, which cancels an ongoing statistics collection task using a specified task ID, with guidance on retrieving the task ID from the `GV$OB_OPT_STAT_GATHER_MONITOR` view.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/500.delete-index-stats.md", "description": "This document describes the `DBMS_STATS.DELETE_INDEX_STATS` procedure in seekdb, which deletes index-related statistics, including parameters for handling partitions, plan cache invalidation, and force deletion despite locks.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/600.delete-table-stats.md", "description": "This document describes the `DBMS_STATS.DELETE_TABLE_STATS` procedure in SeekDB, which deletes table-level statistics and optionally cascades to partitions, subpartitions, and columns, with options to control plan cache invalidation and force deletion despite locks.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/700.delete-schema-stats.md", "description": "This document describes the `DBMS_STATS.DELETE_SCHEMA_STATS` procedure in SeekDB, which deletes statistics for all tables in a specified schema, including its parameters (`ownname`, `no_invalidate`, `force`), usage requirements, exceptions, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/800.delete-schema-prefs.md", "description": "This document describes the `DBMS_STATS.DELETE_SCHEMA_PREFS` procedure in SeekDB, which deletes a specified statistics preference for all tables in a given schema, including its syntax, parameters, exceptions, usage requirements, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/860.delete-system-stats.md", "description": "This document describes the `DBMS_STATS.DELETE_SYSTEM_STATS` procedure in SeekDB, which deletes all system statistics and requires no parameters; it includes syntax, usage notes, exceptions, and an example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/900.delete-table-prefs.md", "description": "This document describes the `DBMS_STATS.DELETE_TABLE_PREFS` procedure in SeekDB, which deletes a specified statistics preference for a table owned by a given user, including syntax, parameters, exceptions, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/100.dbms-udr-overview.md", "description": "This document provides an overview of the `DBMS_UDR` system package in seekdb, which enables user-defined SQL rewrite rules for statements like SELECT, INSERT, UPDATE, and more, including rule syntax, matching principles, privilege requirements, and subprogram references.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/200.create-rule.md", "description": "This document describes the `CREATE_RULE` procedure in SeekDB's `DBMS_UDR` package, which creates custom SQL rewrite rules by specifying a pattern and replacement template for supported DML statements, with constraints on parameter markers and rule uniqueness.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/300.disable-rule.md", "description": "This document describes the `DISABLE_RULE` procedure in the `DBMS_UDR` system package, which disables a custom SQL rewrite rule by name, rendering it inactive for query optimization.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/400.enable-rule.md", "description": "This document describes the `ENABLE_RULE` procedure in the `DBMS_UDR` system package, which activates a custom query rewrite rule by name so it can be applied during SQL execution.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/500.remove-rule.md", "description": "This document describes the `REMOVE_RULE` procedure in OceanBase's DBMS_UDR package, which deletes a custom SQL rewrite rule by name.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/100.dbms-vector-overview.md", "description": "This document provides an overview of the `DBMS_VECTOR` system package in SeekDB, which manages vector indexes, and lists its supported subprograms—including REFRESH_INDEX, REBUILD_INDEX, INDEX_VECTOR_MEMORY_ESTIMATE, and INDEX_VECTOR_MEMORY_ADVISOR—for maintaining and analyzing vector index performance and memory usage.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/200.refresh-index.md", "description": "This document describes the `REFRESH_INDEX` procedure in the `DBMS_VECTOR` package, which incrementally updates a vector index in SeekDB, including its syntax, parameters (such as index name, table name, vector column, refresh threshold, and refresh type), and usage examples with `FAST` refresh.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/300.rebuild-index.md", "description": "This document describes the `REBUILD_INDEX` procedure in the `DBMS_VECTOR` package, which fully rebuilds a vector index with options for parallelism, distance metrics, and index parameters.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/400.index-vector-memory-estimate.md", "description": "This document describes the `INDEX_VECTOR_MEMORY_ESTIMATE` procedure in SeekDB, which estimates memory usage for vector indexes (e.g., HNSW, IVF_FLAT) based on table statistics and index parameters, helping users plan memory allocation for efficient index creation and querying.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/500.index-vector-memory-advisor.md", "description": "This document describes the `INDEX_VECTOR_MEMORY_ADVISOR` function in SeekDB, which estimates memory requirements for creating vector indexes (e.g., HNSW, IVF variants) before they are built, helping users plan resource allocation for vector search workloads.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/100.dbms-workload-repository-overview.md", "description": "This document provides an overview of the `DBMS_WORKLOAD_REPOSITORY` system package in seekdb, which manages the Automatic Workload Repository (AWR) and includes subprograms for creating, modifying, and deleting AWR snapshots, as well as generating ASH reports.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/200.ash-report.md", "description": "This document describes the `ASH_REPORT` procedure in the DBMS_WORKLOAD_REPOSITORY package, which generates an Active Session History (ASH) report in text or HTML format for a specified time range and optional filters such as SQL_ID, TRACE_ID, or WAIT_CLASS.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/300.create-snapshot.md", "description": "This document describes the `CREATE_SNAPSHOT` procedure in the DBMS_WORKLOAD_REPOSITORY system package, which manually triggers a workload repository snapshot for performance monitoring and resets the automatic snapshot timer.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/400.drop-snapshot-range.md", "description": "This document describes the `DROP_SNAPSHOT_RANGE` procedure in the DBMS_WORKLOAD_REPOSITORY system package, which deletes a specified range of AWR snapshots by their low and high snapshot IDs.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/500.modify-snapshot-settings.md", "description": "This document describes the `MODIFY_SNAPSHOT_SETTINGS` procedure in the `DBMS_WORKLOAD_REPOSITORY` package, which configures snapshot retention period and capture interval for the workload repository.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/9000.dbms-hybrid-search/100.dbms-hybrid-search-overview.md", "description": "This document provides an overview of the `DBMS_HYBRID_SEARCH` system package in seekdb, which manages hybrid vector indexes and includes subprograms like `SEARCH` for relevance-ordered JSON results and `GET_SQL` for retrieving executed SQL statements.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/9000.dbms-hybrid-search/200.search.md", "description": "This document describes the `SEARCH` function in SeekDB, which performs hybrid (full-text, scalar, and vector) searches on a specified table and returns results in JSON format ordered by relevance. It details the syntax, parameters, and JSON structure for search queries, including support for boolean logic, range filters, term matching, vector similarity (kNN), and ranking strategies like RRF.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/9000.dbms-hybrid-search/300.get_sql.md", "description": "This document describes the `GET_SQL` function in SeekDB, which returns the actual SQL statement executed for hybrid search queries involving full-text, scalar, and vector retrieval. It details the required parameters (`table_name` and `search_params`), the JSON structure of `search_params`, and supported query types including boolean logic, range/match/term queries, KNN vector search, and ranking strategies like RRF.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/100.dbms-mview-overview.md", "description": "This document provides an overview of the `DBMS_MVIEW` system package in seekdb, which includes subprograms for refreshing materialized views and purging materialized view logs.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/200.purge-log.md", "description": "This document describes the `PURGE_LOG` procedure in SeekDB, which clears all records from a materialized view log to reduce its size, accepting the log's name in `schema.object` or `object` format.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/300.refresh.md", "description": "This document describes the `DBMS_MVIEW.REFRESH` procedure for refreshing materialized views in SeekDB, including syntax, parameters (such as refresh method, parallelism, and nested refresh options), and usage examples for independent and cascading refresh scenarios.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/1100.pl-reserved-keywords.md", "description": "This document lists PL reserved and non-reserved keywords, specifying which identifiers cannot be used for naming database objects like procedures, functions, or variables, and which can be used without quotation marks.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/100.pl-storage-objects-overview.md", "description": "This document provides an overview of PL stored programs in SeekDB, including stored procedures, stored functions, and triggers—covering their creation, usage, and structure within the database system.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/200.variables-in-stored-programs.md", "description": "This document explains how to declare and use local variables in SeekDB stored programs, including syntax, scope rules, data type compatibility, and name resolution conflicts with table columns.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/300.pl-stored-procedure.md", "description": "This document explains how to create, structure, and call stored procedures in PL/SQL, including parameter types (`IN`, `OUT`, `INOUT`), procedural syntax, and usage examples with `CREATE PROCEDURE` and `CALL` statements.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/350.pl-stored-routines-privileges.md", "description": "This document explains how PL privileges in seekdb control access to stored procedures and functions, covering required privileges (CREATE ROUTINE, EXECUTE, ALTER ROUTINE), the automatic_sp_privileges system variable, DEFINER and SECURITY TYPE settings, orphan object handling, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/400.pl-storage-function.md", "description": "This document describes stored functions in SeekDB, including their structure, required `RETURNS` clause, supported characteristics, and usage with `CREATE FUNCTION`, along with a practical example.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/500.pl-trigger.md", "description": "This document describes how to create and use triggers in seekdb, including supported trigger types (`INSERT`, `UPDATE`, `DELETE`), syntax for the `CREATE TRIGGER` statement, usage of `NEW` and `OLD` column references, trigger ordering with `FOLLOWS` and `PRECEDES`, and key limitations such as restrictions on temporary tables and transaction control statements.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/550.pl-event.md", "description": "This document describes seekdb's EVENT feature, which enables automated execution of SQL statements or stored procedures based on time-based schedules, supporting periodic tasks like data maintenance and notifications with configurable intervals, privilege controls, and dynamic management.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/200.storage-object/600.pl-stored-program-usage-restrictions.md", "description": "This document outlines usage restrictions for stored programs (stored procedures, functions, and triggers) in SeekDB, including limitations on SQL statements like `LOAD DATA` and dynamic SQL, transaction control, result set handling, recursion, table modification during function execution, trigger-specific constraints, and identifier precedence rules for variables, parameters, and columns.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/300.cursor/100.overview-of-cursors.md", "description": "This document provides an overview of cursors in PL stored programs, detailing their declaration order, insensitivity, read-only nature, and non-scrollable behavior.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/300.cursor/200.cursor-execution-process.md", "description": "This document describes the cursor execution process in SQL, including declaration (`DECLARE`), opening (`OPEN`), fetching rows (`FETCH`), and closing (`CLOSE`), with syntax details, usage rules, and an example procedure demonstrating cursor handling in a stored program.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/300.cursor/300.cursor-usage-limits.md", "description": "This document outlines the limitations of server-side cursors in MySQL's C API, including their read-only nature, lack of scrollability and naming support, and restrictions on usage with certain SQL statements.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/100.case-pl.md", "description": "This document describes the `CASE` control statement in PL/SQL-like syntax for SeekDB, detailing its two forms—simple case (value-based matching) and searched case (condition-based evaluation)—including usage rules, NULL handling limitations, error behavior when no match is found, and examples demonstrating proper structure with `ELSE` clauses.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/200.if-pl.md", "description": "This document describes the `IF` control statement in PL/SQL-like syntax for SeekDB, detailing its structure with `THEN`, `ELSEIF`, and `ELSE` clauses, usage within stored programs, nesting capabilities, and examples of conditional logic implementation.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/300.ITERATE.md", "description": "This document describes the `ITERATE` control statement in SeekDB, which restarts a loop (LOOP, REPEAT, or WHILE) by jumping back to its beginning using a specified label.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/400.LEAVE.md", "description": "This document describes the `LEAVE` control statement in SeekDB, which exits a labeled block or loop (such as `BEGIN ... END`, `LOOP`, `REPEAT`, or `WHILE`) and can terminate the entire stored program when used with the outermost label.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/500.LOOP.md", "description": "This document describes the `LOOP` control statement in SeekDB, which enables repeated execution of a block of SQL statements until explicitly terminated by a `LEAVE` or `RETURN` statement, with optional labeling for nested loop management.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/600.repeat-pl.md", "description": "This document describes the `REPEAT` control statement in SeekDB's procedural language (PL), which executes a block of statements repeatedly until a specified search condition evaluates to true, ensuring at least one execution. It includes syntax details, usage of labels, and an example demonstrating its use within a stored procedure.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/700.RETURN.md", "description": "This document describes the `RETURN` statement in SeekDB, which terminates a stored function's execution and returns a value to the caller, and clarifies that it is not used in stored procedures or triggers.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/400.control-statement/800.WHILE.md", "description": "This document describes the `WHILE` control statement in SeekDB's procedural language (PL), including its syntax, usage for repeated execution based on a condition, and an example within a stored procedure.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/500.pl-manipulation-statement-mysql/100.call.md", "description": "This document describes the `CALL` statement in MySQL-compatible syntax for invoking stored procedures, including parameter handling (`IN`, `OUT`, `INOUT`), usage with user-defined variables, and retrieving results or affected row counts in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/500.pl-manipulation-statement-mysql/200.do.md", "description": "This document describes the `DO` statement in MySQL, which executes one or more expressions without returning a result set—useful for invoking functions like `SLEEP()` where output is unnecessary.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/100.alter-function.md", "description": "This document describes the `ALTER FUNCTION` SQL statement in SeekDB, which modifies characteristics such as comment, language, data access behavior (`CONTAINS SQL`, `NO SQL`, `READS SQL DATA`, `MODIFIES SQL DATA`), and security context (`SQL SECURITY DEFINER` or `INVOKER`) of an existing stored function—without altering its parameters or body.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/1000.drop-trigger.md", "description": "This document describes the `DROP TRIGGER` SQL statement in SeekDB, including its syntax, usage of the `IF EXISTS` clause, required privileges, and behavior when dropping triggers associated with tables.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/200.alter-procedure.md", "description": "This document describes the `ALTER PROCEDURE` SQL statement in SeekDB, which modifies characteristics such as comment, language, data access behavior (`CONTAINS SQL`, `NO SQL`, `READS SQL DATA`, `MODIFIES SQL DATA`), and security context (`SQL SECURITY DEFINER` or `INVOKER`) of an existing stored procedure—without altering its parameters or body.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/500.create-function.md", "description": "This document describes the `CREATE FUNCTION` SQL statement in seekdb, including its syntax, privilege requirements, security context (`DEFINER` and `SQL SECURITY`), function characteristics (determinism, data access), parameter and return type specifications, and usage examples for creating stored functions.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/600.create-procedure.md", "description": "This document describes the `CREATE PROCEDURE` SQL statement in seekdb, including its syntax, privilege requirements, parameter types (`IN`, `OUT`, `INOUT`), security context (`DEFINER` vs. `INVOKER`), routine characteristics (`DETERMINISTIC`, `SQL SECURITY`, etc.), and usage examples for creating stored procedures.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/700.create-trigger.md", "description": "This document describes the `CREATE TRIGGER` SQL statement in PL/SQL, detailing its syntax, usage, trigger timing (`BEFORE`/`AFTER`), supported events (`INSERT`, `UPDATE`, `DELETE`), definer privileges, and how to reference row data using `OLD` and `NEW` aliases.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/800.drop-function.md", "description": "This document describes the `DROP FUNCTION` SQL statement for removing stored functions in PL/SQL, including syntax, required privileges (`ALTER ROUTINE`), and the use of `IF EXISTS` to avoid errors when the function does not exist.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/600.sql-statements-for-pl-stored-programs/900.drop-procedure.md", "description": "This document describes the `DROP PROCEDURE` SQL statement syntax, usage, required privileges (`ALTER ROUTINE`), and the optional `IF EXISTS` clause to safely remove stored procedures in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/700.pl-database-management-statements/100.show-create-function.md", "description": "This document describes the `SHOW CREATE FUNCTION` statement in SeekDB, which displays metadata and the defining SQL code of a stored function, including required privileges, output fields like `sql_mode` and `Create Function`, and an example usage.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/700.pl-database-management-statements/200.show-create-procedure.md", "description": "This document describes the `SHOW CREATE PROCEDURE` statement in SeekDB, including its syntax, required privileges, returned fields such as `Procedure`, `sql_mode`, and `Create Procedure`, and an example output showing how stored procedure definitions are displayed.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/700.pl-database-management-statements/300.show-create-trigger.md", "description": "This document describes the `SHOW CREATE TRIGGER` statement in TiDB, which displays the original `CREATE TRIGGER` SQL statement and metadata such as SQL mode, character set, collation, and creation timestamp for a specified trigger. It also notes the required privileges and alternative access via the `INFORMATION_SCHEMA.TRIGGERS` table.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/700.pl-database-management-statements/400.show-function-status.md", "description": "This document describes the `SHOW FUNCTION STATUS` SQL statement, which displays metadata about stored functions, including database, name, type, definer, creation/modification timestamps, security type, character set, and collation information, along with required privileges and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/700.pl-database-management-statements/500.show-procedure-status.md", "description": "This document describes the `SHOW PROCEDURE STATUS` SQL statement in SeekDB, which retrieves metadata about stored procedures—including database, name, definer, creation/modification timestamps, security type, and character set details—and explains its syntax, required privileges, and usage with `LIKE` or `WHERE` clauses.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/700.pl-database-management-statements/600.show-triggers.md", "description": "This document describes the `SHOW TRIGGERS` SQL statement in SeekDB, including its syntax, output fields, usage examples, and how it displays trigger metadata such as event type, timing, definer, and associated table.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/800.information-schema-dictionary-view/100.information-schema-parameters.md", "description": "This document describes the `INFORMATION_SCHEMA.PARAMETERS` dictionary view, which provides metadata about parameters of stored procedures and functions, including their names, modes, data types, and ordinal positions, as well as return values for stored functions.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/800.information-schema-dictionary-view/200.information-schema-routines.md", "description": "This document describes the `INFORMATION_SCHEMA.ROUTINES` dictionary view in SeekDB, which provides metadata about stored procedures and functions, including their definitions, creation details, security context, and data access characteristics.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/800.information-schema-dictionary-view/300.information-schema-triggers.md", "description": "This document describes the `INFORMATION_SCHEMA.TRIGGERS` dictionary view, which provides metadata about database triggers, including their names, associated tables, event types (`INSERT`, `UPDATE`, `DELETE`), timing (`BEFORE` or `AFTER`), action statements, creation details, and security context such as the definer and SQL mode.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/100.exception-handling-statement.md", "description": "This document provides an overview of PL exception handling statements in seekdb, including DECLARE CONDITION, DECLARE HANDLER, RESIGNAL, SIGNAL, and GET DIAGNOSTICS, along with handler scope rules and diagnostic area details.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/1000.limitations-of-exception-handling.md", "description": "This document outlines the limitations of exception handling in seekdb's PL feature, including restrictions on using `SIGNAL`, `RESIGNAL`, and `GET DIAGNOSTICS` in prepared statements, treatment of '04' class `SQLSTATE` values, and guidance on correctly retrieving error information.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/200.declare-condition.md", "description": "This document describes the `DECLARE ... CONDITION` statement in seekdb, which allows naming and associating exception conditions with MySQL error codes or SQLSTATE values for use in handlers within stored programs.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/300.declare-handler.md", "description": "This document describes the `DECLARE ... HANDLER` statement in SeekDB, which defines exception handlers for conditions such as SQL errors, warnings, or not-found scenarios within stored procedures. It covers syntax, handler actions (`CONTINUE`, `EXIT`, `UNDO`), condition values (including error codes, SQLSTATE, and named conditions), usage examples, and limitations regarding block label scope.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/400.get-diagnostics.md", "description": "This document describes the `GET DIAGNOSTICS` SQL statement in seekdb, which retrieves diagnostic information—such as error codes, messages, row counts, and SQLSTATE values—from the current or stacked diagnostic area after executing SQL statements, particularly within exception handlers in stored procedures.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/500.resignal.md", "description": "This document describes the `RESIGNAL` statement in SeekDB, which is used within exception handlers in stored procedures, functions, triggers, or events to rethrow or modify existing error conditions. It explains the syntax, usage scenarios—including standalone `RESIGNAL`, `RESIGNAL` with new signal information, and `RESIGNAL` with a condition value—and how it interacts with the diagnostic area stack to preserve or alter error context.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/600.signal.md", "description": "This document describes the `SIGNAL` statement in SeekDB, which is used to raise custom errors or warnings in stored procedures and functions by specifying an `SQLSTATE` value or named condition, along with optional error details such as `MESSAGE_TEXT` and `MYSQL_ERRNO`.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/700.scope-rules-for-handlers.md", "description": "This document explains the scope rules for exception handlers in seekdb stored programs, detailing how handler applicability is determined by block structure, condition specificity, and priority, with examples illustrating handler selection behavior across nested scopes.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/800.diagnostic-area.md", "description": "This document explains the structure, contents, and behavior of the SQL diagnostics area in SeekDB, including statement and condition information items, how the diagnostic area is cleared and filled by SQL statements, and the use of the diagnostics area stack with `GET STACKED DIAGNOSTICS` during handler execution.", "branch": "V1.1.0"}
{"path": "450.reference/300.pl/900.pl-exception-handling-statement/900.conditional-processing-and-out-or-inout-parameters.md", "description": "This document explains how unhandled exceptions and RESIGNAL statements in exception handlers affect the return of modified OUT and INOUT parameter values from stored procedures in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/100.error-code-overview.md", "description": "This document provides an overview of seekdb error messages, including their MySQL-compatible format, use of variables (e.g., `%.*s`), and a categorized list of error code ranges with descriptions and links to detailed references.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/1000.9500-9999.md", "description": "This document lists seekdb error codes 9500–9999, which correspond to process language (PL) errors, including issues related to parameter modes, object references, autonomous transactions, loop controls, variable declarations, cursor usage, type methods (MAP/ORDER), and naming conflicts.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/1050.10000-12000.md", "description": "This document lists and explains SeekDB error codes in the range 10000–12000, covering OBKV and client-related issues such as TTL misconfigurations, HBase table state errors, authentication failures, schema mismatches, Redis protocol parsing errors, and sensitive rule conflicts.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/1100.22998-30926-38104-38105.md", "description": "This document describes seekdb error codes 22998, 30926, 38104, and 38105, covering issues related to CLOB/NCLOB support, non-deterministic DML operations, updatable columns in JOIN clauses, and row concurrency conflicts.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/200.0001-3999.md", "description": "This document lists seekdb error codes in the range 0001–3999 that are compatible with MySQL error codes, providing mappings between seekdb-specific error identifiers and their corresponding standard MySQL errors for troubleshooting database operations.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/300.4000-4499.md", "description": "This document lists seekdb error codes in the range 4000–4499, including causes and solutions for general errors such as object initialization issues, timeouts, memory limits, I/O failures, and schema or serialization problems.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/500.5000-5999.md", "description": "This document lists seekdb SQL layer error codes in the range 5000–5999, including parsing errors, type conversion issues, schema and column problems, plan generation failures, and other SQL execution errors, along with their causes and recommended solutions.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/600.6000-6999.md", "description": "This document describes seekdb error codes in the range 6000–6999, which correspond to object layer issues including transaction management, MVCC, and clog-related errors, with details on causes and recommended solutions for each code.", "branch": "V1.1.0"}
{"path": "450.reference/600.error-code/800.8000-8999.md", "description": "This document lists seekdb error codes 8000–8999, which indicate critical errors requiring the client to close the SQL connection, including details and solutions for errors such as server initialization (8001), server shutdown (8002), and packet checksum failure (8003).", "branch": "V1.1.0"}
{"path": "450.reference/700.telemetry/700.telemetry.md", "description": "This document explains seekdb's built-in telemetry feature, which anonymously collects usage and system metrics to improve the product, details what data is gathered, how privacy is protected, and how to enable or disable telemetry using the `TELEMETRY_ENABLED` environment variable.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/10.pyseekdb-sdk-get-started.md", "description": "This document provides a getting started guide for pyseekdb, the Python SDK for OceanBase's seekdb, covering installation, supported platforms (Linux, macOS, Windows), connection modes (embedded, server, and OceanBase Database), and next steps including API reference and sample code.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/10.pyseekdb-simple-sample.md", "description": "This document provides a simple Python example using the pyseekdb SDK to demonstrate basic operations with embedding functions in embedded mode, including connecting to seekdb, creating a collection, adding documents (with automatic vector generation), performing text-based semantic search, and displaying results.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/100.pyseekdb-hybrid-search-sample.md", "description": "This document provides a practical example of using `hybrid_search()` in the PySeekDB SDK, demonstrating how it combines full-text and vector similarity search with independent filtering and Reciprocal Rank Fusion (RRF) to improve result relevance over the standard `query()` method.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/50.pyseekdb-complete-sample.md", "description": "This document provides a complete Python example demonstrating all core features of the pyseekdb SDK, including connection modes, collection management, DML operations (add, update, upsert, delete), DQL queries with vector similarity search and metadata filtering, and collection introspection methods.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/5.pyseekdb-changelog.md", "description": "This document outlines the changelog for pyseekdb SDK version 1.1.0, highlighting new features such as extended collection name limits (up to 512 characters), full-text search with custom tokenizers via `FulltextIndexConfig`, support for 11 embedding platforms, persistent metadata storage for embedding functions, and an experimental `table-fork` feature enabling fast, copy-on-write collection snapshots for A/B testing and rollback.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/10.api-overview.md", "description": "This document provides an overview of the seekdb Python SDK APIs, including database management (via AdminClient), collection operations, data manipulation (DML), and data querying (DQL) such as vector similarity search and hybrid search.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/100.admin-client.md", "description": "This document describes the `AdminClient` class in the pyseekdb SDK, which provides database management operations for both embedded and remote seekdb or OceanBase Database instances, including connection parameters and supported APIs like `create_database`, `get_database`, `delete_database`, and `list_databases`.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/100.database-overview-of-api.md", "description": "This document provides an overview of the SeekDB SDK APIs for database management, including creating, retrieving, listing, and deleting databases.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/200.create-database-of-api.md", "description": "This document describes the `create_database()` API in the pyseekdb SDK, which creates a new database using an AdminClient connection, including prerequisites, limitations on database naming, parameter details, and usage examples for both embedded seekdb and OceanBase Database.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/300.get-database-of-api.md", "description": "This document describes the `get_database()` API in the pyseekdb SDK, which retrieves metadata such as name, charset, collation, and tenant (for OceanBase) of a specified database using the AdminClient.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/400.list-database-of-api.md", "description": "This document describes the `list_databases()` API in the pyseekdb SDK, which retrieves a paginated list of databases from a SeekDB instance using the AdminClient, with support for filtering by tenant in OceanBase environments.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/500.delete-database-of-api.md", "description": "This document describes the `delete_database()` method in the pyseekdb SDK, which allows administrators to delete a database using the `AdminClient`, including prerequisites, required privileges, parameters, and usage examples for both embedded and server modes of SeekDB or OceanBase Database.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/100.create-collection-of-api.md", "description": "This document describes the `create_collection()` API in the pyseekdb SDK, which creates a new collection (table) in the database with specified name, index configuration, and optional embedding function. It includes prerequisites, parameter details, usage examples, and related operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/200.get-collection-of-api.md", "description": "This document describes the `get_collection()` API in the pyseekdb SDK, which retrieves an existing collection by name and optionally configures its embedding function and index settings. It includes usage examples, request/response parameters, and related collection operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/250.get-or-create-collection-of-api.md", "description": "This document describes the `get_or_create_collection()` API in pyseekdb SDK, which creates a new collection or retrieves an existing one based on the provided name, configuration, and embedding function. It includes prerequisites, parameter details, usage examples, and related operations for managing collections in SeekDB.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/260.fork-collection-of-api.md", "description": "This document describes the `fork()` API in pyseekdb SDK, which creates a copy of an existing collection with the same data, including its usage, prerequisites, parameters, and related operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/300.list-collection-of-api.md", "description": "This document describes the `list_collections()` API in the pyseekdb SDK, which retrieves a list of all collections in the database, including details such as name, dimension, embedding function, distance metric, and metadata.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/350.count-collection-of-api.md", "description": "This document describes the `count_collection()` method in the pyseekdb SDK, which returns the number of collections in a SeekDB database. It includes usage prerequisites, a code example, and links to related collection management APIs.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/360.has-collection-of-api.md", "description": "This document describes the `has_collection()` API in the pyseekdb SDK, which checks whether a specified collection exists in the database and returns a boolean value. It includes usage prerequisites, request/response parameters, code examples, and links to related collection operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/400.delete-collection-of-api.md", "description": "This document describes the `delete_collection()` API in the pyseekdb SDK, which deletes a specified collection from the database. It includes prerequisites, request parameters, usage examples, and related collection management operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/50.collection-overview-of-api.md", "description": "This document provides an overview of collection management APIs in the pyseekdb SDK, including operations to create, retrieve, list, fork, and delete collections, as well as check existence and count collections.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/100.dml-overview-of-api.md", "description": "This document provides an overview of Data Manipulation Language (DML) operations in the pyseekdb SDK, including APIs for inserting (`add`), updating (`update`), upserting (`upsert`), and deleting (`delete`) records in a collection.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/200.add-data-of-api.md", "description": "This document describes the `add()` API in pyseekdb SDK for inserting new data into a collection, including parameter details, usage examples, and prerequisites such as required privileges and client setup.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/300.update-data-of-api.md", "description": "This document describes the `update()` method in the pyseekdb SDK for updating existing records in a collection, including required parameters, usage examples, and prerequisites such as client setup and user privileges.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/400.upsert-data-of-api.md", "description": "This document describes the `upsert()` method in the pyseekdb SDK, which inserts new records or updates existing ones based on provided IDs, supporting optional embeddings, documents, and metadata.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/500.delete-data-of-api.md", "description": "This document describes the `delete()` API in the pyseekdb SDK, which allows deletion of records from a collection by ID, metadata filter, or document filter, with examples and prerequisites for usage.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/100.dql-overview-of-api.md", "description": "This document provides an overview of SeekDB's Data Query Language (DQL) APIs, including `query()`, `get()`, and `hybrid_search()` methods for retrieving data from collections using vector similarity, exact matches, or combined full-text and vector search.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/200.query-interfaces-of-api.md", "description": "This document describes the `query()` API method in pyseekdb for performing vector similarity searches, including parameters for query vectors or texts, filtering by metadata or document content, and controlling result fields and counts.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/300.get-interfaces-of-api.md", "description": "This document describes the `get()` API in pyseekdb SDK for retrieving documents from a collection by ID, metadata, or document content—without vector search—supporting filtering, pagination, and field inclusion.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/400.hybrid-search-of-api.md", "description": "This document describes the `hybrid_search()` API in pyseekdb, which enables hybrid search by combining full-text and vector similarity search with configurable ranking (e.g., Reciprocal Rank Fusion), metadata/document filtering, and result inclusion options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/500.filter-operators-of-api.md", "description": "This document describes the filter operators available in the pySeekDB SDK for use in `where` and `where_document` clauses, including comparison operators (`$eq`, `$ne`, `$gt`, etc.), membership operators (`$in`, `$nin`), logical operators (`$and`, `$or`), and text search operators (`$contains`, `$regex`).", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/50.apis/50.client.md", "description": "This document describes the `Client` class in the pyseekdb SDK, which enables connections to embedded or remote seekdb and OceanBase Database instances, supporting both local and server-mode operations with detailed parameter specifications and available collection management APIs.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/100.default-embedding-function-of-api.md", "description": "This document describes the `DefaultEmbeddingFunction` in pyseekdb, which uses the all-MiniLM-L6-v2 model to generate 384-dimensional embeddings for text, and explains how to use it for similarity search without additional setup.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/200.create-custim-embedding-functions-of-api.md", "description": "This document explains how to create a custom embedding function for pyseekdb by implementing the `EmbeddingFunction` protocol, including handling input/output types, managing vector dimensions, and integrating with models like Sentence Transformers or OpenAI.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/300.using-custom-embedding-functions-of-api.md", "description": "This document explains how to use a custom embedding function with the PySeekDB SDK when creating or retrieving a collection, enabling automatic vector generation for documents and queries.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/100.amazon-bedrock-py.md", "description": "This document describes how to use the `AmazonBedrockEmbeddingFunction` wrapper in the pyseekdb SDK to generate embeddings via Amazon Bedrock for use with seekdb collections, including setup, authentication, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/1000.tencent-hunyuan-py.md", "description": "This document describes the `TencentHunyuanEmbeddingFunction` in the `pyseekdb` SDK, which wraps Tencent Hunyuan's embedding API to generate 1024-dimensional text embeddings for use in RAG, agent memory, and other semantic applications. It covers authentication via API key, installation requirements, and usage examples with customizable parameters like timeout and environment variable names.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/1100.voyageai-py.md", "description": "This document describes how to use the `VoyageaiEmbeddingFunction` in pyseekdb to integrate Voyage AI's embedding models—such as `voyage-4-large`—for semantic search, RAG, and agent memory applications, including configuration options like input type differentiation and dimensionality reduction.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/200.cohere-py.md", "description": "This document describes the `CohereEmbeddingFunction` wrapper in pyseekdb, which enables integration with Cohere's embedding models (e.g., `embed-english-v3.0`, `embed-multilingual-v3.0`) for semantic search and retrieval tasks using LiteLLM, including setup, authentication via API key, and usage examples with input types like `search_document` and `search_query`.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/300.google-vertex-ai-py.md", "description": "This document describes how to use the `GoogleVertexEmbeddingFunction` wrapper in the pyseekdb SDK to generate text embeddings via Google Vertex AI for use with seekdb collections, including setup, authentication, and example usage.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/400.jina-ai-py.md", "description": "This document describes how to use the `JinaEmbeddingFunction` wrapper in pyseekdb to generate embeddings with Jina AI models via LiteLLM, including setup, authentication, and examples for both English and multilingual models.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/500.ollama-py.md", "description": "This document describes the `OllamaEmbeddingFunction` wrapper in pyseekdb, which enables local or remote embedding generation using Ollama's OpenAI-compatible API with support for custom models, endpoints, timeouts, and dimensions.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/600.openai-py.md", "description": "This document describes the `OpenAIEmbeddingFunction` in the `pyseekdb` SDK, which enables integration with OpenAI's embedding models (like `text-embedding-3-small` and `text-embedding-3-large`) for generating semantic vector representations of text, supporting use cases such as semantic search, RAG, and clustering. It covers installation, authentication via API key, configuration options (including model selection, dimensions, timeout, and retries), and example usage.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/700.qwen-py.md", "description": "This document describes the `QwenEmbeddingFunction` wrapper in the `pyseekdb` SDK for using Tongyi Qianwen (Qwen) embedding models via Dashscope, including setup, authentication, and usage examples with parameters like model name, API key, timeout, and output dimensions.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/800.sentence-transformer-py.md", "description": "This document describes how to use the `SentenceTransformerEmbeddingFunction` in the PySeekDB SDK to generate sentence embeddings using pre-trained Sentence Transformer models like `all-MiniLM-L6-v2` for semantic search, clustering, and RAG applications.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/900.siliconflow-py.md", "description": "This document describes the `SiliconflowEmbeddingFunction` in the pyseekdb SDK, which enables integration with SiliconFlow's cloud-hosted embedding models (such as BGE and Qwen Embedding series) for semantic search, RAG, and recommendation tasks, supporting configurable output dimensions and API key authentication.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/50.ef-overview-py.md", "description": "This document provides an overview of embedding functions in the pyseekdb SDK, explaining how they convert text to vectors for semantic and hybrid search, listing supported providers (e.g., OpenAI, Cohere, Sentence Transformers), and detailing usage patterns—including default behavior with `all-MiniLM-L6-v2` and instructions for implementing custom embedding functions.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/10.seekdb-js-get-started.md", "description": "This document provides a quick start guide for seekdb-js, the Node.js client SDK for OceanBase Database, covering installation requirements, setup steps, and links to API references and sample code examples.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/30.sdk-samples-of-seekdb-js/10.seekdb-js-simple-sample.md", "description": "This document provides a simple JavaScript example using the seekdb-js SDK to demonstrate basic vector database operations with automatic embedding generation, including connecting to SeekDB, creating a collection, adding documents, performing semantic search via text queries, and displaying results.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/30.sdk-samples-of-seekdb-js/100.seekdb-js-hybrid-search-sample.md", "description": "This document provides a JavaScript example demonstrating SeekDB's `hybridSearch()` functionality, which combines full-text and vector similarity search with independent filtering and Reciprocal Rank Fusion (RRF) for improved relevance over the standard `query()` method.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/30.sdk-samples-of-seekdb-js/50.seekdb-js-complete-sample.md", "description": "This document provides a complete, executable example of using the seekdb-js SDK, demonstrating client connection, collection management, DML operations (add, update, upsert, delete), DQL operations (query, get, hybridSearch), filter operators, and collection metadata inspection.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/5.seekdb-js-changelog.md", "description": "This document provides the changelog for seekdb-js, detailing new features, bug fixes, and enhancements in versions V1.1.0 and V1.1.1, including longer collection names, full-text search support, expanded embedding platform integrations, experimental table-fork functionality, and updates to the default embedding package installation.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/10.api-overview-of-seekdb-js.md", "description": "This document provides an overview of the seekdb-js API, including database management, collection operations, data manipulation (DML), and data querying (DQL) methods, along with their usage requirements and links to detailed documentation.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/100.seekdbadminclient-of-seekdb-js.md", "description": "This document describes the `SeekdbAdminClient` class in the seekdb-js SDK, which provides database management operations such as creating, listing, retrieving, and deleting databases for both seekdb and OceanBase Database server modes.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/110.database-of-seekdb-js/100.database-overview-of-seekdb-js.md", "description": "This document provides an overview of database management in SeekDB JS, including APIs to create, retrieve, list, and delete databases.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/110.database-of-seekdb-js/200.create-database-of-seekdb-js.md", "description": "This document describes the `createDatabase()` method in seekdb-js, which creates a new database using `SeekdbAdminClient`, including prerequisites, limitations on database naming, parameter details, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/110.database-of-seekdb-js/300.get-database-of-seekdb-js.md", "description": "This document describes the `getDatabase()` method in seekdb-js, which retrieves metadata for a specified database using `SeekdbAdminClient`, including parameters, usage examples, and response details.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/110.database-of-seekdb-js/400.list-database-of-seekdb-js.md", "description": "This document describes the `listDatabases()` method in seekdb-js, which retrieves a list of databases from a SeekDB instance using `SeekdbAdminClient`, with optional pagination and tenant filtering.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/110.database-of-seekdb-js/500.delete-database-of-seekdb-js.md", "description": "This document describes the `deleteDatabase()` method in seekdb-js, which deletes a database using `SeekdbAdminClient`, including prerequisites, request parameters (name, tenant), usage examples, and required privileges.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/100.create-collection-of-seekdb-js.md", "description": "This document describes the `createCollection()` method in the SeekDB JavaScript SDK, which creates a new collection (equivalent to a database table) with optional vector search and full-text indexing configurations, requiring appropriate user permissions and an optional embedding function for vectorization.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/200.get-collection-of-seekdb-js.md", "description": "This document describes the `getCollection()` method in the SeekDB JavaScript SDK, which retrieves an existing collection by name and optionally specifies or overrides its embedding function for vector operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/250.get-or-create-collection-of-seekdb-js.md", "description": "This document describes the `getOrCreateCollection()` API in seekdb-js, which creates a new collection or retrieves an existing one based on the provided name and configuration, including vector dimension, distance metric, and optional embedding function.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/260.fork-collection-of-seekdb-js.md", "description": "This document describes the `fork()` method in seekdb-js, which creates a new collection by copying an existing one. It includes prerequisites, usage examples, request parameters, and related collection operations, noting that the feature is experimental as of seekdb V1.1.0.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/300.list-collection-of-seekdb-js.md", "description": "This document describes the `listCollections()` method in seekdb-js, which retrieves all collections from a SeekDB database when connected via `SeekdbClient`, including details like name, dimension, embedding function, and distance metric.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/350.count-collection-of-seekdb-js.md", "description": "This document describes the `countCollection()` method in the seekdb-js SDK, which returns the total number of collections in a SeekDB database when connected via `SeekdbClient`.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/360.hascollection-collection-of-seekdb-js.md", "description": "This document describes the `hasCollection()` API in seekdb-js, which checks whether a specified collection exists in the database when connected via `SeekdbClient`.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/400.delete-collection-of-seekdb-js.md", "description": "This document describes the `deleteCollection()` method in the SeekDB JavaScript SDK, which deletes a specified collection when connected via `SeekdbClient`, including prerequisites, request parameters, and usage examples.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/200.collection-of-seekdb-js/50.collection-overview-of-seekdb-js.md", "description": "This document provides an overview of collection management in seekdb-js, including APIs for creating, retrieving, listing, and deleting collections, as well as checking existence and copying collections.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/300.dml-of-seekdb-js/100.dml-overview-of-seekdb-js.md", "description": "This document provides an overview of SeekDB JavaScript SDK's Data Manipulation Language (DML) operations, including `add()`, `update()`, `upsert()`, and `delete()` APIs for managing records in a collection.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/300.dml-of-seekdb-js/200.add-data-of-seekdb-js.md", "description": "This document describes the `add()` method in seekdb-js for inserting new data into a collection, including prerequisites, request parameters, usage examples, and related operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/300.dml-of-seekdb-js/300.update-data-of-seekdb-js.md", "description": "This document describes the `update()` method in seekdb-js for modifying existing records in a collection, including prerequisites, request parameters (ids, embeddings, documents, metadatas), usage examples, and related data manipulation operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/300.dml-of-seekdb-js/400.upsert-data-of-seekdb-js.md", "description": "This document describes the `upsert()` method in seekdb-js, which inserts new records or updates existing ones based on provided IDs, supporting optional embeddings, documents, and metadata.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/300.dml-of-seekdb-js/500.delete-data-of-seekdb-js.md", "description": "This document describes the `delete()` method in the Seekdb JavaScript SDK, which allows deletion of records from a collection by ID, metadata filter, or document content filter, and includes prerequisites, parameter details, usage examples, and related operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/400.dql-of-seekdb-js/100.dql-overview-of-seekdb-js.md", "description": "This document provides an overview of SeekDB JS's Data Query Language (DQL) operations, including `query()` for vector similarity search, `get()` for ID or metadata-based retrieval, and `hybrid_search()` for combined full-text and vector search with ranking.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/400.dql-of-seekdb-js/200.query-interfaces-of-seekdb-js.md", "description": "This document describes the `query()` interface in seekdb-js for performing vector similarity searches, including parameters like `queryEmbeddings`, `queryTexts`, `nResults`, filters (`where`, `whereDocument`), and response fields such as `ids`, `distances`, and `documents`.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/400.dql-of-seekdb-js/300.get-interfaces-of-seekdb-js.md", "description": "This document describes the `get()` method in SeekDB JS SDK for retrieving documents by ID, metadata, or content filters without vector search, including parameters, usage examples, and related operations.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/400.dql-of-seekdb-js/400.hybrid-search-of-seekdb-js.md", "description": "This document describes the `hybridSearch()` API in seekdb-js, which enables hybrid search by combining full-text and vector similarity search with configurable ranking, metadata filtering, and result inclusion options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/400.dql-of-seekdb-js/500.filter-operators-of-seekdb-js.md", "description": "This document describes the filter operators available in SeekDB JS for data and text filtering, including comparison operators (`$eq`, `$ne`, `$gt`, etc.), logical operators (`$and`, `$or`), array operators (`$in`, `$nin`), and full-text search operators (`$contains`, `$regex`).", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/50.seekdbclient-of-seekdb-js.md", "description": "This document describes the `SeekdbClient` class in the seekdb-js SDK, which provides a unified interface for connecting to both seekdb server mode and OceanBase Database, including connection parameters, usage examples, and supported collection management APIs.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/100.default-embedding-function-of-seekdb-js.md", "description": "This document explains how to use the default embedding function in seekdb-js, which leverages the local Xenova/all-MiniLM-L6-v2 model for generating vector embeddings without an API key, and covers installation, setup, and usage options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/50.ef-overview-js.md", "description": "This document provides an overview of embedding functions in seekdb-js, explaining how they convert text to vectors for semantic search, listing supported providers (e.g., OpenAI, Cohere, Ollama), and detailing usage patterns including binding to collections, using the default local model, and implementing custom embedding functions.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/500.create-custim-embedding-functions-of-seekdb-js.md", "description": "This document explains how to create and register a custom embedding function in SeekDB JS by implementing the `EmbeddingFunction` interface, including required methods like `generate`, `getConfig`, and `buildFromConfig`, along with an example using a sentence transformer.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/600.using-custom-embedding-functions-of-seekdb-js.md", "description": "This document explains how to use a custom embedding function with SeekDB JS when creating or retrieving a collection, enabling automatic vector generation for documents and queries.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/100.amazon-bedrock-js.md", "description": "This document describes how to use the `AmazonBedrockEmbeddingFunction` in seekdb-js to generate embeddings via Amazon Bedrock, including installation, authentication, and configuration options for AWS region and embedding models.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/1000.tencent-hunyuan-js.md", "description": "This document describes how to use the `TencentHunyuanEmbeddingFunction` in seekdb-js to generate 1024-dimensional text embeddings from Tencent Hunyuan's GetEmbedding API for applications like RAG and agent memory, including setup, authentication, and configuration options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/1100.voyageai-js.md", "description": "This document describes how to use the `VoyageAIEmbeddingFunction` in seekdb-js to generate embeddings with Voyage AI models like `voyage-4-large` for semantic search, RAG, and agent memory applications, including setup, authentication, and configuration options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/200.cohere-js.md", "description": "This document describes how to use the `CohereEmbeddingFunction` in seekdb-js to generate Cohere embeddings for semantic search, clustering, and recommendations, including setup, authentication, and configuration options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/300.google-vertex-ai-js.md", "description": "This document describes how to use the `GoogleVertexEmbeddingFunction` in seekdb-js to generate text embeddings via Google Vertex AI, including setup, authentication, and configuration options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/400.jina-js.md", "description": "This document describes how to use the `JinaEmbeddingFunction` in seekdb-js to generate embeddings with Jina AI models for semantic search, including setup, authentication, and configuration options.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/500.ollama-js.md", "description": "This document describes how to use `OllamaEmbeddingFunction` from the `@seekdb/ollama` package to generate embeddings via Ollama's local, OpenAI-compatible API for use with seekdb collections.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/600.openai-js.md", "description": "This document describes how to use the `OpenAIEmbeddingFunction` from the `@seekdb/openai` package to generate text embeddings with OpenAI models for semantic search, RAG, and other AI applications, including configuration options and authentication setup.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/700.qwen-js.md", "description": "This document describes how to use the `QwenEmbeddingFunction` from the `@seekdb/qwen` package to generate text embeddings with Qwen (Tongyi Qianwen) models in seekdb, including setup, authentication via Dashscope API key, and configuration options like model name, dimensions, and region.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/800.sentence-transformer-js.md", "description": "This document describes the `SentenceTransformerEmbeddingFunction` in SeekDB JS, which generates sentence embeddings using pre-trained Transformer models like BERT for use in semantic search, clustering, and RAG applications.", "branch": "V1.1.0"}
{"path": "450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/900.siliconflow-js.md", "description": "This document describes how to use the `SiliconFlowEmbeddingFunction` in seekdb-js to generate embeddings from SiliconFlow's hosted models (such as BGE and Qwen Embedding series) for use in RAG, search, and recommendation systems, including setup, authentication, and configuration options.", "branch": "V1.1.0"}
{"path": "500.tutorials/100.create-ai-app-demo/100.build-kb-in-seekdb.md", "description": "This document provides a tutorial for building a local knowledge base desktop application using seekdb, featuring multi-format document support, vector-based semantic search with HNSW indexes, and AI-powered conversational Q&A via LLMs like Qwen, all while ensuring data privacy through embedded, local-first storage.", "branch": "V1.1.0"}
{"path": "500.tutorials/100.create-ai-app-demo/300.build-multi-model-application-based-on-oceanbase.md", "description": "This document demonstrates how to build a cultural tourism assistant using seekdb's multi-model integration capabilities, combining spatial data (GIS), vector search, and LLM Agent workflows on OceanBase to enable hybrid search and personalized travel recommendations.", "branch": "V1.1.0"}
{"path": "500.tutorials/100.create-ai-app-demo/400.build-image-search-app-in-seekdb.md", "description": "This document provides a step-by-step tutorial for building an image search application using seekdb's vector search capabilities, including setup, configuration, and UI interaction.", "branch": "V1.1.0"}
{"path": "500.tutorials/100.create-ai-app-demo/500.using-ten-framework-and-oceanbase-powermem-to-create-personalized-intelligent-voice-assistant.md", "description": "This document provides a tutorial on building a personalized, memory-enabled voice assistant using the TEN Framework and OceanBase PowerMem, covering memory-driven personalization, continuity, emotional connection, proactive service, and technical implementation details like memory persistence strategies and personalized greeting generation.", "branch": "V1.1.0"}
{"path": "500.tutorials/100.create-ai-app-demo/600.build-a-rag-system-with-seekdb.md", "description": "This document provides a step-by-step tutorial for building a Retrieval-Augmented Generation (RAG) application using seekdb, including importing Markdown documents, configuring embedding types (default, local, or API-based), and launching a Streamlit-powered query interface.", "branch": "V1.1.0"}
{"path": "500.tutorials/200.scenarios/15.basic-sql-operations.md", "description": "This document covers basic SQL operations in seekdb, including creating and managing databases, tables, and indexes using statements like `CREATE DATABASE`, `CREATE TABLE`, `ALTER TABLE`, `DROP TABLE`, `CREATE INDEX`, and `DROP INDEX`.", "branch": "V1.1.0"}
{"path": "500.tutorials/200.scenarios/30.experience-vector-search.md", "description": "This document provides a tutorial on using seekdb for vector search, covering vector column creation, indexing with HNSW/IVF, exact vs. approximate search, and hybrid scalar-vector queries via SQL, with examples for AI applications.", "branch": "V1.1.0"}
{"path": "500.tutorials/200.scenarios/40.experience-full-text-indexing.md", "description": "This document provides a hands-on tutorial on using seekdb's full-text indexing feature for efficient document retrieval, covering setup, querying with Boolean mode, performance comparison with LIKE queries, relevance scoring via BM25, and basic tuning techniques.", "branch": "V1.1.0"}
{"path": "500.tutorials/200.scenarios/50.experience-hybrid-search.md", "description": "This document provides a tutorial on using seekdb's hybrid search feature, which combines vector-based semantic search and full-text keyword search to deliver more accurate and comprehensive results, with examples for pure vector search, pure full-text search, and hybrid search scenarios.", "branch": "V1.1.0"}
{"path": "500.tutorials/200.scenarios/60.experience-ai-function.md", "description": "This document provides a hands-on tutorial for using seekdb's AI Function Service, demonstrating how to register AI models and endpoints, and utilize built-in SQL functions like `AI_EMBED`, `AI_COMPLETE`, `AI_PROMPT`, and `AI_RERANK` for vector generation, text completion, prompt templating, and reranking—enabling AI-powered data processing directly within the database.", "branch": "V1.1.0"}
{"path": "500.tutorials/200.scenarios/70.experience-hybrid-vector-index.md", "description": "This document provides a hands-on tutorial for using seekdb's hybrid vector index, which enables semantic text retrieval by automatically converting text to vectors during insertion and querying—eliminating manual embedding. It covers setup, index creation, text insertion, and both text-based and vector-based retrieval methods.", "branch": "V1.1.0"}
{"path": "600.demos/10.demo-overview.md", "description": "This document provides an overview of live demos showcasing seekdb's AI-powered vector search capabilities, including a RAG-based AI knowledge base for Q&A and a multi-modal image search application using SQL and deep learning.", "branch": "V1.1.0"}