seekdb documentation catalog

This catalog provides a comprehensive index of all seekdb documentation. When users ask about seekdb-related topics, you can use the descriptions to find relevant documents and fetch the content from the specified URLs.

Base URL: https://raw.githubusercontent.com/oceanbase/seekdb-doc/V1.1.0/en-US/

提示

All File Paths below are relative paths. The full URL = Base URL + File Path

---

Documentation Overview

• File Path: 10.doc-overview.md

  • Description: Comprehensive documentation for seekdb, covering setup, SDK usage, and API integration with practical examples and tutorials for building AI applications. Includes guides for both embedded and server deployment modes.

---

Get Started

This category contains quick start tutorials and basic operation guides for the seekdb database.

Seekdb Overview

• File Path: 100.get-started/10.seekdb-overview/10.seekdb-overview.md

  • Description: An AI-native search database that unifies relational, vector, text, JSON, and GIS data in a single engine, enabling hybrid search and in-database AI workflows with full MySQL compatibility.

Use Seekdb With Sql

• File Path: 100.get-started/100.use-seekdb-with-sql/10.deploy-seekdb-testing-environment.md

  • Description: This document provides a step-by-step guide for using seekdb in client/server mode with SQL, covering deployment, database operations, and hybrid search optimization techniques.

Ai Coding

• File Path: 100.get-started/200.ai-coding/100.building-personal-knowledge-base-through-ai-dialogue-using-seekdb-mcp-server.md

  • Description: This tutorial explains how to build a personal knowledge base using the seekdb MCP server, enabling natural-language note storage, semantic and hybrid search, and AI-driven queries within compatible coding tools. It covers setup, collection creation, and practical usage for managing technical notes.

• File Path: 100.get-started/200.ai-coding/200.building-an-ai-programming-assistant-that-understands-vector-databases-with-seekdb-claude-code.md

  • Description: This tutorial explains how to build a vector-aware AI coding assistant by integrating the seekdb plugin with Claude Code, enabling accurate documentation retrieval and hybrid search application development in Python.

• File 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 guide explains how to install and use the seekdb Cursor Extension to provide Cursor AI with up-to-date seekdb documentation, enabling accurate code generation and answers for seekdb-related development tasks.

Use Seekdb With Sdk

• File 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 using OceanBase's pyseekdb Python SDK for embedded seekdb operations, covering installation, database creation, data insertion, hybrid search, and environment cleanup. It includes practical examples for implementing vector database functionality in a Linux environment.

Development Guide

This category contains detailed development guides for seekdb features including vector search, hybrid search, AI functions, SDK, and multi-model data support.

Develop Overview

• File Path: 200.develop/10.develop-overview/10.develop-overview.md

  • Description: This documentation covers development with seekdb through Python SDKs and SQL interfaces, detailing connection methods, supported platforms, and database operations for both embedded and remote instances.

Connect To Seekdb

• File Path: 200.develop/100.connect-to-seekdb/100.connection-methods-overview.md

  • Description: This document provides an overview of connection methods for seekdb, including clients, drivers, ORM frameworks, and connection pools for various programming languages.

• File 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 details the prerequisites, connection procedure, and examples for connecting to seekdb using a MySQL client, including supported versions and command parameters.

• File 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 Spring Boot sample application for connecting to seekdb, detailing setup procedures, configuration steps, and common troubleshooting for performing database operations like table creation, data insertion, and queries.

• File 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 SpringBatch sample program demonstrating how to connect to seekdb and perform basic database operations, including table creation, data insertion, and querying. It includes prerequisites, setup steps, and troubleshooting guidance for developers.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/100.java/300.connect-to-seekdb-through-spring-jdbc.md

  • Description: This document explains how to build an application using Spring JDBC and MySQL Connector/J to perform basic database operations with seekdb, including setup, configuration, and execution steps.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/100.java/400.connect-to-seekdb-through-springjpa.md

  • Description: This document explains how to build a SpringDataJPA application to connect to seekdb, covering setup, configuration, and basic database operations like table creation, data insertion, and queries.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/100.java/500.connect-to-seekdb-through-hibernate.md

  • Description: This document provides instructions for connecting to seekdb using the Hibernate framework, including prerequisites, setup steps, and troubleshooting common issues. It also includes a sample project download and code structure overview.

• File 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 for connecting to seekdb using the MyBatis framework, including setup, configuration, and running a sample project with basic database operations. It also includes troubleshooting tips and a project structure overview.

• File 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 version compatibility, setup prerequisites, and a step-by-step procedure with sample code. It also provides a downloadable Java project for reference.

• File 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 sample program demonstrating how to connect to seekdb using mysqlclient in Python, including steps for creating tables, inserting data, and querying data. It includes prerequisites, installation instructions, and a downloadable project with configuration and database operation files.

• File 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 guide for using the PyMySQL library to connect to a seekdb database and perform basic operations, including creating tables, inserting data, querying records, and deleting tables. It includes prerequisites, step-by-step instructions, and downloadable sample code.

• File 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 for connecting to seekdb using the MySQL-connector-python driver, including installation instructions, connection configuration, and sample code for database operations. It also covers common error handling scenarios and troubleshooting methods.

• File 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 for connecting to seekdb using SQLAlchemy in Python, covering installation, configuration, and performing basic CRUD operations including table creation, data insertion, updates, and queries.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/200.python/500.django-connection-to-seekdb-sample-program.md

  • Description: This guide explains how to connect Django to a seekdb database and perform basic operations like table creation, data insertion, updates, and queries. It includes prerequisites, step-by-step configuration, and error handling.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/200.python/600.peewee-connection-to-seekdb-sample-program.md

  • Description: This document provides instructions for connecting to seekdb using the peewee ORM library in Python, including steps for installation, configuration, and performing basic database operations such as creating tables, inserting, updating, and querying data. It also covers error handling and prerequisites for setup.

• File 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 sample program using MySQL Connector/C to connect to seekdb and perform basic database operations including creating tables, inserting data, and querying data. It includes prerequisites, installation instructions, and step-by-step procedures for building and running the application.

• File 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 guide for building a Go application using the Go-SQL-Driver/MySQL driver and seekdb, covering installation, configuration, and basic database operations like creating tables, inserting data, and querying. It includes prerequisites, step-by-step instructions, and sample code for connecting to and interacting with a seekdb database.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/400.go/200.gorm-connection-seekdb-example-program.md

  • Description: This document provides a guide for building an application using GORM and seekdb, covering installation, connection setup, and basic database operations like creating tables, inserting data, and querying data. It includes a downloadable sample project with code examples and prerequisites for Go and driver setup.

• File 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 and perform basic database operations, including table creation and data insertion. It provides prerequisites and step-by-step instructions for setup and verification.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/500.php/200.use-mysqli-driver-to-connect-seekdb.md

  • Description: This document provides instructions for using the MySQLi PHP extension to connect to seekdb and perform basic database operations, including creating tables, inserting data, querying records, and dropping tables. It includes prerequisites, step-by-step procedures, and code examples for implementation.

• File 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 PHP's PDO driver to connect to seekdb and perform basic database operations including table creation, data insertion, queries, and deletion. It includes prerequisites, connection configuration, and verification steps.

• File 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 sample program demonstrating how to connect Rust applications to seekdb for database operations including table creation, data insertion, and querying. It includes setup instructions, code examples, and troubleshooting guidance.

• File Path: 200.develop/100.connect-to-seekdb/300.sample-program/600.rust/200.sea-connection-seekdb-program.md

  • Description: This document provides a guide for building applications with SeaORM and seekdb, covering environment setup, database configuration, entity definition, and CRUD operations implementation. It includes practical examples for creating tables, inserting data, and querying records in a Rust application.

• File 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 sample program demonstrating how to connect ActiveRecord to seekdb for performing database operations including table creation, data insertion, and querying. It includes setup prerequisites, step-by-step implementation instructions, and troubleshooting guidance.

• File 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 sample program for connecting to a seekdb database using the mysql2 Ruby gem, demonstrating basic operations including table creation, data insertion, and querying. It includes step-by-step instructions, prerequisites, and troubleshooting guidance for building applications with seekdb.

• File 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 for building a Ruby application using Sequel with seekdb, covering database connection setup, table creation, data insertion, and query operations. It includes prerequisites, detailed implementation code, and troubleshooting FAQs.

• File Path: 200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/100.database-connection-pool-configuration.md

  • Description: This document covers database connection pool configuration, including basic concepts, parameter recommendations, and JDBC settings to optimize database access and performance. It provides guidance on selecting pool types, configuring parameters, and implementing best practices for efficient connection management.

• File 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 for building an application using Tomcat connection pool, OceanBase Connector/J, and seekdb to perform basic database operations such as creating tables, inserting, updating, deleting, and querying data. It includes prerequisites, detailed setup instructions, and a downloadable sample project.

• File 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 sample application demonstrating the use of C3P0 connection pool with MySQL Connector/J and seekdb, covering basic database operations and configuration steps.

• File 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 sample program using Proxool connection pool with MySQL Connector/J and seekdb to perform basic database operations, including table creation, insertion, deletion, update, and query. It includes prerequisites, setup steps, and project code details.

• File 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 guide for building an application using HikariCP, MySQL Connector/J, and seekdb to perform database operations such as table creation, insertion, deletion, updating, and querying. It includes prerequisites, setup instructions, and a downloadable sample project.

• File 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 guide for building a Java application using DBCP connection pool, MySQL Connector/J, and seekdb to perform basic database operations including table creation, data insertion, deletion, updating, and querying. It includes prerequisites, detailed setup instructions, and a downloadable sample project with configuration examples.

• File Path: 200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/700.commonpool-configuration-example.md

  • Description: This document provides a sample project using Commons Pool, MySQL Connector/J, and seekdb to perform basic database operations. It includes setup instructions, configuration details, and code examples for connecting to and interacting with a seekdb database.

• File 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 for building a Java application using a Druid connection pool and MySQL Connector/J to perform basic database operations with seekdb. It includes prerequisites, setup instructions, and a downloadable sample project with configuration details.

• File Path: 200.develop/100.connect-to-seekdb/400.use-the-database-connection-pool/900.jdbc-connection-pool-configuration-example.md

  • Description: Provides a JDBC configuration example for connecting Java applications to OceanBase databases, including recommended parameters for optimizing connection performance and batch operations. Covers key settings like batch statement rewriting, multi-query support, and prepared statement caching.

Design Database Schema

• File Path: 200.develop/200.design-database-schema/10.database-schema-overview.md

  • Description: This document provides an overview of seekdb's database schema components, including tables, indexes, data types, and views. It covers table types like partitioned, columnar, and hybrid tables, as well as update modes and various indexing options.

• File Path: 200.develop/200.design-database-schema/20.create-database-in-develop.md

  • Description: This document provides instructions for creating databases in seekdb using SQL statements, covering prerequisites, naming conventions, limitations, and practical examples. It also includes recommendations for security, character sets, and best practices in production environments.

• File Path: 200.develop/200.design-database-schema/30.create-table-in-develop.md

  • Description: This document explains how to create tables in seekdb using SQL, covering prerequisites, table design, column definitions, primary keys, and other constraints. It includes practical examples and best practices for effective data management.

• File 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 implementation in seekdb, covering automatic validation, optimized storage format, and semi-structured encoding for efficient data handling. It also provides references to related JSON functions and detailed usage guides.

• File Path: 200.develop/200.design-database-schema/35.multi-model/100.json/200.create-a-json-value.md

  • Description: This document explains JSON value creation and structure, covering objects, arrays, strings, numbers, and boolean values with examples. It also details seekdb's JSON column operations, limitations, and semi-structured encoding for performance optimization.

• File Path: 200.develop/200.design-database-schema/35.multi-model/100.json/300.querying-and-modifying-json-values.md

  • Description: This documentation explains how to query and modify JSON values in seekdb using path expressions and operators like -> and ->>. It covers syntax for extracting specific data, modifying partial values with JSON functions, and working with arrays and objects through DML operations.

• File Path: 200.develop/200.design-database-schema/35.multi-model/100.json/400.json-formatted-data-type-conversion.md

  • Description: Explains JSON data type conversion rules using the CAST function, covering transformations between JSON and other data types including character sets and NULL values. Includes practical SQL examples for implementation.

• File Path: 200.develop/200.design-database-schema/35.multi-model/100.json/500.json-partial-update.md

  • Description: This document describes seekdb's JSON Partial Update feature, which allows modifying specific JSON fields without rewriting entire documents. It covers enabling the feature, supported JSON expressions, update granularity, and storage considerations.

• File Path: 200.develop/200.design-database-schema/35.multi-model/100.json/600.json-semi-struct.md

  • Description: Explains how to enable and configure seekdb's semi-structured encoding feature for JSON columns, which optimizes query performance by automatically extracting frequently accessed JSON paths into independent columns. Covers configuration parameters, data storage formats, and usage examples.

• File 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 in seekdb's GIS feature, detailing fundamental types like POINT, LINESTRING, and POLYGON, their collection variants, and the abstract GEOMETRY type.

• File 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) for defining geographic locations, covering projected and geographic SRS types along with the default SRID 0. It details how to retrieve SRS information from the database and specifies that all geometry values in calculations must share the same SRID.

• File Path: 200.develop/200.design-database-schema/35.multi-model/200.spatial/300.create-spatial-columns.md

  • Description: Explains how to create spatial columns using CREATE TABLE and ALTER TABLE statements in seekdb, including required SRID specifications and constraints for spatial indexing. Covers syntax examples and operational limitations.

• File 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, covering required constraints like NOT NULL columns and SRID definitions, along with practical SQL examples for implementation.

• File Path: 200.develop/200.design-database-schema/35.multi-model/200.spatial/500.spatial-data-format.md

  • Description: This document covers the two spatial data formats supported by seekdb: Well-Known Text (WKT) and Well-Known Binary (WKB). It details the syntax, structure, and usage examples for various geometric objects including points, lines, polygons, and their multi-type collections.

• File Path: 200.develop/200.design-database-schema/35.multi-model/300.char-and-text/100.char-and-varchar.md

  • Description: Compares CHAR and VARCHAR data types, detailing their storage methods, length specifications, and trailing space handling. Covers syntax, character set options, and practical usage differences between fixed-length and variable-length string storage.

• File Path: 200.develop/200.design-database-schema/35.multi-model/300.char-and-text/200.text.md

  • Description: This document covers the TEXT data types for storing text data, including TINYTEXT, TEXT, MEDIUMTEXT, and LONGTEXT, detailing their maximum lengths, storage requirements, character set specifications, and SQL mode behavior.

• File Path: 200.develop/200.design-database-schema/35.multi-model/300.char-and-text/300.full-text-index.md

  • Description: This document details the creation and use of full-text indexes in seekdb, covering supported column types, tokenizers, and complex DML operations on indexed tables. It includes syntax rules, limitations, and practical examples for implementing efficient text search.

• File Path: 200.develop/200.design-database-schema/40.create-index-in-develop.md

  • Description: This document explains how to create indexes in seekdb using SQL statements, covering prerequisites, limitations, recommendations, and practical examples for unique, non-unique, local, and global indexes.

• File Path: 200.develop/200.design-database-schema/450.select-vector-index.md

  • Description: Provides recommendations for selecting and optimizing dense vector indexes in seekdb, comparing HNSW and IVF series based on performance, memory usage, and scalability. Includes decision flowcharts, parameter suggestions, and guidance for partitioned tables and large-scale data scenarios.

• File Path: 200.develop/200.design-database-schema/50.fork-table.md

  • Description: FORK TABLE creates an isolated, consistent snapshot copy of a source table for independent read/write operations, enabling data versioning, testing, and iteration without full data duplication. This experimental feature supports branching workflows while maintaining snapshot consistency and write isolation between tables.

Read And Write Data

• File 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 tables using INSERT statements, covering single and batch inserts, constraint handling, and the INSERT OVERWRITE SELECT operation for data replacement.

• File 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 tables using the UPDATE statement and other methods, including syntax, examples, and considerations for unique constraints and transaction size.

• File 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 from tables using DELETE and TRUNCATE TABLE statements, including required privileges, syntax, and examples for partial and complete data removal.

• File 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 to insert or update data in a table, including syntax, examples, and prerequisite permissions. It covers scenarios with and without primary key or unique key conflicts.

• File Path: 200.develop/300.read-and-write-data/100.write-data/500.batch-data-generation-in-develop.md

  • Description: This document details three methods for generating large volumes of test data in seekdb: using a shell script to automate SQL generation, employing a stored procedure for direct database insertion, and utilizing ODC. It includes prerequisites, step-by-step procedures, and examples for each approach.

• File Path: 200.develop/300.read-and-write-data/200.read-data/100.single-table-query.md

  • Description: This document provides instructions for performing single-table queries in seekdb using SQL, covering syntax, execution order, and practical examples with data filtering and logical conditions.

• File Path: 200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/100.inner-join.md

  • Description: Explains the syntax and usage of INNER JOIN operations in SQL, including join conditions, Cartesian products, and equivalent WHERE clause implementations with practical examples.

• File Path: 200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/200.full-join.md

  • Description: Explains the FULL JOIN operation in SQL, including syntax and examples that demonstrate how it returns all rows from both tables, filling unmatched columns with NULL values.

• File Path: 200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/300.left-join.md

  • Description: Explains the LEFT JOIN operation in SQL, including syntax, examples, and use cases for retrieving all records from the left table and matched records from the right table with NULL values for unmatched rows.

• File Path: 200.develop/300.read-and-write-data/200.read-data/200.multi-table-join-query/400.right-join.md

  • Description: Explains the RIGHT JOIN operation in SQL, including syntax and examples of how it returns all records from the right table with matching records from the left table or NULL values when no match exists.

• File 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, covering their types, usage scenarios, and keywords with practical examples. It details how subqueries function in various clauses like SELECT, FROM, and WHERE, including scalar, column, row, and table subqueries.

• File 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, which allow subqueries to reference columns from preceding tables in the FROM clause, and covers their syntax, limitations, and usage examples.

• File 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 demonstrates how to use arithmetic operators like addition, subtraction, multiplication, and division in SQL queries, providing practical examples with sample tables and data.

• File 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: Explains how to use SELECT FOR UPDATE to lock query results in seekdb, including NOWAIT and SKIP LOCKED options to handle locked rows. Provides practical examples demonstrating locking behavior and transaction interactions.

• File 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 statement, which places shared locks on queried data to prevent writes while allowing reads, and includes a practical example demonstrating its usage and behavior across concurrent transactions.

• File 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 demonstrates how to use numeric functions like SUM(), AVG(), and ROUND() in SQL queries, providing practical examples with a sample dataset. It covers calculating totals, averages, and rounded values from grouped data.

• File 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 in queries, including the CONCAT() and CONCAT_WS() functions, and demonstrates how to configure sql_mode to enable the || operator for string concatenation with practical SQL examples.

• File 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 provides examples of using string functions in queries, including LENGTH(), CHAR_LENGTH(), SUBSTR(), CONCAT(), and case conversion functions. It demonstrates practical applications with sample SQL queries and data.

• File 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, extracting date parts, and performing date arithmetic with functions like NOW(), EXTRACT(), and DATE_ADD().

• File 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 in queries, providing examples for converting between time strings and time types, as well as between numeric and string types using CONVERT() and CAST() functions.

• File 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 queries, including examples with GROUP BY clauses and SQL mode considerations.

• File 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 identify and convert NULL values in database queries using functions like IS NULL, NVL(), and IFNULL(). It includes practical examples demonstrating the replacement of NULL values with recognizable strings.

• File 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 SQL queries, providing examples of both simple and searched CASE clauses to implement conditional logic without stored procedures.

• File Path: 200.develop/300.read-and-write-data/200.read-data/500.query-collection-operations.md

  • Description: Explains how to use UNION, UNION ALL, INTERSECT, and MINUS/EXCEPT operators to combine query results in seekdb, including syntax and examples.

Llm

• File Path: 200.develop/400.llm/100.model-service-overview.md

  • Description: The model service in seekdb enables registration and management of AI models and endpoints, providing the foundation for AI functions like text generation, embedding, and reranking. It supports various model types and providers through the DBMS_AI_SERVICE package.

• File Path: 200.develop/400.llm/200.model-service-permission.md

  • Description: This document explains AI MODEL permissions for managing AI models and endpoints, covering CREATE, ALTER, and DROP permissions along with their syntax and examples. It also distinguishes these permissions from ACCESS AI MODEL permissions required for calling AI functions.

• File 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 package and associated views. It covers creation, modification, deletion, and viewing of AI models and endpoints.

Ai Workflow

• File Path: 200.develop/50.ai-workflow/50.vector-search-workflow.md

  • Description: This document outlines the AI application workflow using seekdb vector search, covering the conversion of unstructured data into vectors, storage and indexing in seekdb, and hybrid search integration with large language models for inference.

Vector Embedding

• File Path: 200.develop/500.vector-embedding/100.vector-embedding-overview.md

  • Description: This document provides an overview of vector embedding concepts and explains how to generate embeddings in seekdb using either built-in AI functions or external models. It covers the conversion of unstructured data into numerical vectors and their storage within relational tables.

• File 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 models, including syntax, prerequisites, and examples.

• File Path: 200.develop/500.vector-embedding/300.external-embedding-models.md

  • Description: This document explains how to generate vector embeddings using external models, including locally pre-trained options like Sentence Transformers and Hugging Face, as well as online services, providing greater flexibility beyond built-in functions.

Search

• File 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, supported vector data types, indexing methods, and search operations. It details capabilities for storing and querying high-dimensional vectors with various distance calculations and SQL operators.

• File Path: 200.develop/600.search/300.vector-search/120.vector-search-quick-start-sql.md

  • Description: This guide explains how to perform vector search in seekdb using SQL, including creating vector columns and indexes, inserting vector data, and executing similarity searches. It provides practical examples and best practices for efficient vector operations.

• File Path: 200.develop/600.search/300.vector-search/150.vector-data-type.md

  • Description: This document describes seekdb's vector data types for AI vector search, covering storage of dense and sparse floating-point arrays, index creation, and hybrid search capabilities. It includes syntax examples and requirements for vector dimensions and data validation.

• File Path: 200.develop/600.search/300.vector-search/160.store-vector-data.md

  • Description: This document explains how to store and manage unstructured, semi-structured, and structured data in seekdb using vector columns, supporting hybrid search capabilities. It includes practical examples for creating tables, inserting vector data, and leveraging vector search techniques.

• File 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 and IVF series) and in-memory sparse indexes, along with their characteristics, limitations, and memory considerations.

• File 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 manage memory usage for vector indexes in seekdb, including procedures for memory estimation and optimization techniques for partitioned tables.

• File 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, covering HNSW and IVF index types for accelerating vector searches. It includes details on index characteristics, memory usage, and supported distance metrics for nearest neighbor queries.

• File Path: 200.develop/600.search/300.vector-search/200.vector-index/300.dense-vector-index/200.hnsw-index.md

  • Description: This document details the creation, search, and deletion of HNSW, HNSW_SQ, and HNSW_BQ vector indexes in seekdb, including syntax, parameters, and practical examples.

• File Path: 200.develop/600.search/300.vector-search/200.vector-index/300.dense-vector-index/300.ivf-index.md

  • Description: This document provides syntax and examples for creating, searching, and dropping IVF and IVF_PQ vector indexes in seekdb, including required parameters and usage considerations.

• File 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 details the creation, querying, and usage of in-memory sparse vector indexes in seekdb, including DDL, DML, retrieval operations, and index maintenance. It covers syntax, parameters, and examples for efficient handling of sparse vector data with support for up to 500,000 dimensions.

• File 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 vector indexes in seekdb using system views and maintain them through incremental or full refresh procedures to ensure optimal search performance.

• File Path: 200.develop/600.search/300.vector-search/200.vector-index/700.vector-index-performance-tuning.md

  • Description: This document explains how to configure and monitor seekdb's automatic IVF index performance optimization tasks, including cache warming and cleanup, and provides guidance on scheduling, monitoring, and canceling these tasks.

• File Path: 200.develop/600.search/300.vector-search/250.vector-function.md

  • Description: This document describes the vector functions supported by seekdb, including distance calculations (L2, cosine, inner product, Manhattan) and arithmetic operations, along with usage considerations and examples.

• File Path: 200.develop/600.search/300.vector-search/300.vector-similarity-search.md

  • Description: This document explains vector similarity search methods in seekdb, covering both exact nearest neighbor searches using full scans and approximate searches using vector indexes. It includes practical examples and execution plan analyses for both approaches.

• File Path: 200.develop/600.search/300.vector-search/800.vector-search-faq.md

  • Description: This document addresses common vector search implementation issues, covering data dimensionality requirements, scalability limitations based on database resources, and dimensional compression techniques for high-dimensional indexing.

• File Path: 200.develop/600.search/400.semantic-search.md

  • Description: This document explains how to use semantic search in seekdb, which automatically converts text to vectors and builds indexes for simplified vector-based retrieval. It covers setup, index creation, embedding modes, and search operations using both raw text and vectors.

• File Path: 200.develop/600.search/500.full-text-search.md

  • Description: This document describes seekdb's full-text search capabilities, including indexing methods, supported tokenizers, and DML operations for efficient text retrieval across various data types and scenarios.

• File Path: 200.develop/600.search/500.hybrid-search.md

  • Description: This document describes hybrid search in seekdb, combining vector-based semantic search and full-text keyword search for more accurate results through integrated ranking. It includes usage instructions, system functions, and practical examples with sample tables and queries.

• File Path: 200.develop/600.search/600.ai-rerank.md

  • Description: This document describes the AI_RERANK function, which uses deep learning models to reorder search results by semantic relevance. It provides syntax, parameters, and examples for implementing AI-powered search result optimization within SQL queries.

Ai Function

• File Path: 200.develop/700.ai-function/0.ai-function-overview.md

  • Description: AI Function Service enables SQL-based integration of AI models within seekdb for text generation, embedding, reranking, and prompt processing. It covers permissions, model management, and function implementation through SQL expressions.

• File 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. It includes syntax for granting and revoking permissions along with practical examples demonstrating permission requirements and function usage.

• File Path: 200.develop/700.ai-function/200.text-generation-function.md

  • Description: This documentation describes seekdb's text generation AI functions, including AI_COMPLETE and AI_PROMPT, which integrate large language models into SQL for data processing tasks like summarization, translation, and classification. It covers prerequisites, syntax, and examples for using these functions within the database.

Integrations

This category contains guides for integrating seekdb with various AI models, frameworks, developer tools, and workflows.

Frameworks

• File Path: 300.integrations/100.frameworks/100.langchain.md

  • Description: This document explains how to integrate seekdb's vector search capabilities with LangChain and the Tongyi Qianwen API to build a document question answering system. It provides step-by-step instructions for setup, data loading, and querying.

• File Path: 300.integrations/100.frameworks/200.llamaindex.md

  • Description: This document explains how to integrate seekdb's vector search capabilities with LlamaIndex and the Tongyi Qianwen API to build a document question answering system. It provides prerequisites, setup instructions, and a code example for implementation.

• File Path: 300.integrations/100.frameworks/300.springai.md

  • Description: This document explains how to integrate seekdb's vector search capabilities with Spring AI Alibaba, providing step-by-step instructions for data import and similarity search implementation in Java applications. It includes prerequisites, project setup, configuration details, and testing procedures.

Model Platforms

• File Path: 300.integrations/200.model-platforms/100.jina.md

  • Description: This guide explains how to integrate Jina AI's embedding models with seekdb's vector database for building multimodal search and RAG applications, including setup steps and code examples for storing and querying vectors.

• File Path: 300.integrations/200.model-platforms/200.openai.md

  • Description: This document explains how to integrate OpenAI's language models with seekdb for storing and querying vectorized data, including prerequisites and step-by-step instructions for data insertion and retrieval.

• File Path: 300.integrations/200.model-platforms/300.qwen.md

  • Description: This document provides instructions for integrating Alibaba Cloud's Qwen language model with seekdb to store and query vectorized data, including prerequisites, setup steps, and sample code for data insertion and retrieval.

• File Path: 300.integrations/200.model-platforms/500.huggingface.md

  • Description: This document provides a technical guide for integrating seekdb's vector storage and search capabilities with Hugging Face's machine learning models. It includes prerequisites, connection setup instructions, and Python code examples for storing embeddings and performing semantic searches.

• File Path: 300.integrations/200.model-platforms/600.ollama.md

  • Description: This guide explains how to integrate seekdb's vector storage and search capabilities with Ollama's local LLMs, providing code examples for embedding generation, data storage, and semantic search using the Qwen3 model.

• File Path: 300.integrations/200.model-platforms/700.google-gemini.md

  • Description: This guide explains how to integrate seekdb's vector storage and search capabilities with Google Gemini's AI models to build an AI assistant. It covers prerequisites, environment setup, and provides code examples for embedding generation, data storage, and semantic search operations.

• File Path: 300.integrations/200.model-platforms/800.cloudflare-workers-ai.md

  • Description: This guide explains how to integrate seekdb's vector storage and search capabilities with Cloudflare Workers AI to build semantic search applications. It provides prerequisites, connection setup, and code examples for generating embeddings and performing vector similarity searches.

Developer Tools

• File Path: 300.integrations/300.developer-tools/100.cursor.md

  • Description: This document provides a step-by-step guide for integrating the seekdb MCP Server with the Cursor AI code editor to enable SQL execution and backend application development. It covers prerequisites, server configuration, connection setup, and demonstrates building a FastAPI project with database operations.

• File Path: 300.integrations/300.developer-tools/200.cline.md

  • Description: This document provides instructions for integrating the seekdb MCP Server with the Cline AI coding assistant, covering setup, configuration, and testing steps to enable vector data storage and search capabilities. It includes prerequisites, server installation, environment configuration, and a demonstration of creating a FastAPI project with sample database operations.

• File Path: 300.integrations/300.developer-tools/300.continue.md

  • Description: This guide explains how to integrate the Continue IDE extension with the seekdb MCP Server to enable direct SQL execution and backend application prototyping. It includes prerequisites, setup steps, and a practical example using FastAPI to create a RESTful API.

• File Path: 300.integrations/300.developer-tools/400.trae.md

  • Description: This document explains how to integrate the TrAE IDE with the seekdb MCP Server to build backend applications using FastAPI. It provides step-by-step instructions for setup, configuration, and testing the connection to interact with databases.

• File Path: 300.integrations/300.developer-tools/600.augment-code.md

  • Description: This guide demonstrates how to configure and integrate the seekdb MCP Server with Augment Code to enable direct database interactions and streamline backend application development. It covers prerequisites, setup steps, and configuration details for connecting to seekdb using the Model Context Protocol.

• File Path: 300.integrations/300.developer-tools/700.claude-code.md

  • Description: This document explains how to integrate the seekdb MCP Server with Claude Code to build backend applications, including setup, configuration, and creating RESTful APIs with FastAPI. It covers prerequisites, database connection setup, and step-by-step implementation guidance.

• File Path: 300.integrations/300.developer-tools/800.kiro.md

  • Description: This document provides a step-by-step guide for integrating the seekdb MCP Server with the Kiro IDE to build backend applications. It covers prerequisites, server configuration, and creating RESTful APIs using FastAPI with seekdb.

Workflows

• File Path: 300.integrations/400.workflows/400.dify.md

  • Description: This document explains how to integrate seekdb's vector search capabilities with the Dify LLM application platform, covering prerequisites, deployment methods, and connection steps. It provides instructions for setting up the integration to enable embedding-based vector search within Dify applications.

• File Path: 300.integrations/400.workflows/500.n8n.md

  • Description: This guide demonstrates how to build a Chat to seekdb workflow using n8n, covering prerequisites, database setup, deployment of n8n and Ollama, and step-by-step AI Agent workflow configuration.

Data Analyst

• File Path: 300.integrations/500.data-analyst/100.camel.md

  • Description: This document explains how to integrate CamelAI with seekdb to store vectorized data and perform semantic searches using natural language queries. It includes prerequisites, setup instructions, and code examples for loading data and executing searches.

Mcp

• File Path: 300.integrations/600.mcp/100.toolbox.md

  • Description: This guide demonstrates how to build a code-free seekdb MCP server using Google GenAI Toolbox, covering setup, configuration, and integration with MCP clients for enhanced database management and analysis.

• File Path: 300.integrations/600.mcp/200.seekdb-mcp-server.md

  • Description: Enables AI assistants to interact with a seekdb database by translating natural language into database operations, including vector collection management, advanced search, AI functions, and persistent memory across sessions. Supports both embedded and client/server deployments for building knowledge bases, prototyping RAG applications, and enhancing coding workflows.

Plugin

• File Path: 300.integrations/650.plugin/100.agent-skill.md

  • Description: A Claude Code plugin that provides direct access to seekdb's official documentation, enabling accurate code suggestions and technical guidance for vector search, hybrid search, and AI functions within terminal workflows. Features automatic context detection, comprehensive documentation retrieval, and minimal setup requirements.

• File Path: 300.integrations/650.plugin/200.cursor-extension.md

  • Description: This Cursor editor extension integrates seekdb's official documentation into the AI assistant, providing domain-specific knowledge for vector database development. It enables accurate code suggestions, technical Q&A, and dual-mode document access with automatic fallback to local copies when needed.

Others

• File Path: 300.integrations/700.others/100.firecrawl.md

  • Description: This tutorial demonstrates building a Retrieval-Augmented Generation (RAG) pipeline using seekdb for vector storage and Firecrawl for web data scraping, including code examples for data extraction, embedding generation, and semantic search.

Guides

This category contains operational guides for deploying, managing, and maintaining seekdb.

Obshell

• File Path: 400.guides/1000.obshell/100.obshell-overview.md

  • Description: OceanBase Shell (obshell) is a no-installation command-line tool for managing OceanBase clusters and standalone databases, enabling unified administration and simplifying integration with third-party tools. It is included by default with OceanBase seekdb installations.

• File Path: 400.guides/1000.obshell/1000.error.md

  • Description: This document provides a comprehensive list of obshell error codes with descriptions and troubleshooting solutions, covering agent initialization, database operations, system resource issues, and common command-line errors.

• File Path: 400.guides/1000.obshell/300.obshell-clients/100.agent-commands.md

  • Description: This document describes obshell agent commands for managing the obshell service, including start, stop, restart, and upgrade operations with their respective options and configurations.

• File Path: 400.guides/1000.obshell/300.obshell-clients/200.seekdb-commands.md

  • Description: This document describes the obshell seekdb commands for managing a seekdb instance, including start, restart, stop, and show operations with their respective options and usage examples.

• File Path: 400.guides/1000.obshell/300.obshell-clients/300.utilities-commands.md

  • Description: This document describes obshell task management commands for viewing, canceling, rolling back, retrying, skipping, and monitoring tasks. It includes detailed syntax, options, and examples for each command.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/100.dashboard-overview.md

  • Description: obshell Dashboard is a web-based management interface for OceanBase's seekdb, providing resource management, performance monitoring, and administrative controls for instances, databases, users, and system parameters.

• File 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 basic instance information, start/stop/restart operations, obshell upgrades, IP whitelist configuration, and major compaction management.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/300.dashboard-db.md

  • Description: This document explains how to use the Database Management page in the obshell Dashboard to view, create, modify, and delete databases, including details on parameters and search functions.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/400.dashboard-user.md

  • Description: This document details user management operations in the obshell Dashboard, including creating, locking, modifying permissions, changing passwords, and deleting users. It provides instructions for viewing all users and managing their access and privileges.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/500.dashboard-alarm.md

  • Description: This document details the Alarm Center in the obshell Dashboard, explaining how to view, filter, and manage alert events, set suppression rules, and configure alert monitoring for system stability.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/600.dashboard-monitor.md

  • Description: This documentation describes the Performance monitoring page in the obshell Dashboard, which provides real-time monitoring of seekdb instance metrics across performance, transactions, storage, and host performance to identify bottlenecks and optimize resource usage.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/700.dashboard-parameter.md

  • Description: This document explains how to view and modify parameters for a seekdb instance using the obshell Dashboard's Parameter Management page. It covers searching for parameters, viewing descriptions, and updating values through the console interface.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/800.dashboard-package.md

  • Description: This document explains how to view, upload, and uninstall software packages in the obshell Dashboard. It covers package details, filtering options, and the requirements for uploading RPM packages.

• File Path: 400.guides/1000.obshell/350.obshell-dashboard/900.ob-dashboard-task.md

  • Description: The Mission Center page in the obshell Dashboard provides task management capabilities, allowing users to view, filter, and manage tasks with operations such as cancellation, rollback, retry, and log troubleshooting for failed tasks.

• File Path: 400.guides/1000.obshell/900.configure-monitor.md

  • Description: This document provides instructions for deploying and configuring the monitoring components required by obshell Dashboard, including obagent, Prometheus, and Alertmanager, to enable performance monitoring and alerting features. It covers installation, configuration steps, and verification procedures for each component.

Data Load And Dump

• File 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, including setup steps, syntax examples, and considerations for each approach. It covers permissions, performance optimizations, and limitations for efficient data loading.

Performance Test

• File Path: 400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/100.ob-vector-search-bench-test.md

  • Description: This document provides instructions for testing the performance of seekdb using VectorDBBench, including prerequisites, test scenarios, and step-by-step procedures for running benchmark tests with the HNSW index.

• File Path: 400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/200.vectobench-benchmark-report-of-seekdb.md

  • Description: This benchmark report details the test environment, methodology, and performance results for seekdb 1.1.0 using VectorDBBench, including qps, latency, and recall metrics for 4C8G and 1C2G instance configurations.

• File Path: 400.guides/1100.performance-test/200.sysbench-test-on-seekdb/100.use-sysbench-to-test-the-performance-of-seekdb.md

  • Description: This document provides instructions for using Sysbench to test the performance of seekdb, including environment preparation, test plans, and step-by-step execution of various performance benchmarks. It covers key parameters and optimization steps for accurate performance evaluation.

• File Path: 400.guides/1100.performance-test/200.sysbench-test-on-seekdb/200.sysbench-benchmark-report-of-seekdb.md

  • Description: This document details the Sysbench benchmark test environment, plan, and performance results for seekdb instances with 1C2G and 4C8G specifications, covering various workload types and thread counts.

• File 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 step-by-step instructions for running the TPC-H benchmark test against seekdb using official TPC-H tools, including environment setup, data generation, and query execution. It covers prerequisites, system tuning, and detailed procedures for testing analytical query performance in a data warehousing context.

• File Path: 400.guides/1100.performance-test/300.tpc-h-test-on-seekdb/200.tpc-h-benchmark-report-of-seekdb.md

  • Description: This report details the TPC-H benchmark test plan, environment, and results for seekdb 1.1.0 using 10GB of data, with a total execution time of 12.16 seconds across all queries at a concurrency of 4.

• File Path: 400.guides/1100.performance-test/400.mldr-test-on-seekdb/100.mldr-test-of-seekdb.md

  • Description: This guide explains how to benchmark seekdb using the MLDR framework to evaluate retrieval quality and latency across multiple query types. It covers setup, configuration, and execution steps for testing recall, NDCG, and query performance.

• File Path: 400.guides/1100.performance-test/400.mldr-test-on-seekdb/200.mldr-benchmark-report-of-seekdb.md

  • Description: This report details the benchmark test plan, environment, and results for evaluating seekdb's retrieval quality using the MLDR dataset, including performance metrics like response time and accuracy scores.

Deploy

• File Path: 400.guides/400.deploy/100.prepare-servers.md

  • Description: This document outlines the server requirements for deploying seekdb, including minimum hardware specifications, supported operating systems, and necessary BIOS configuration settings.

• File Path: 400.guides/400.deploy/50.deploy-overview.md

  • Description: This documentation outlines seekdb's two deployment modes: embedded mode for running as a library within applications on various endpoints, and server mode for single-machine deployment in CI/CD and testing environments. It also details the specific deployment methods available for each mode.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/100.configurations-overview.md

  • Description: This document provides pre-deployment configuration requirements for seekdb, outlining necessary operating system and environment settings for both trial and production environments. It covers user creation, disk planning, system limits, kernel parameters, and security configurations.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/300.create-regular-user.md

  • Description: This document provides instructions for creating a regular user with sudo privileges and directory ownership for enterprise SeekDB deployments, including specific shell commands for user creation, password setting, and sudo configuration.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/400.plan-disks.md

  • Description: This document provides guidelines for planning and mounting data, transaction log, and installation disks for seekdb servers, including partitioning schemes, storage requirements, and step-by-step mounting procedures for both enterprise and personal users.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/500.configure-limits-conf.md

  • Description: This document explains how to configure the limits.conf file to set resource limits for processes, including open files, stack size, core files, and user processes. It provides specific configuration examples and instructions for verification.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/600.configure-sysctl-conf.md

  • Description: This document provides instructions for optimizing Linux system performance by configuring sysctl.conf parameters, including network settings, memory management, and kernel adjustments for enterprise environments. It includes specific recommendations for ARM architecture deployments and guidance on applying the changes.

• File Path: 400.guides/400.deploy/500.environment-and-configuration-checks/700.disable-firewall-and-selinux.md

  • Description: Provides instructions for disabling both the firewall and SELinux, including specific commands for system deactivation and verification.

• File Path: 400.guides/400.deploy/600.python-seekdb.md

  • Description: This document outlines the embedded deployment method for seekdb, which runs as a library within applications for mobile, desktop, IoT, and edge devices. It details environment requirements, installation via pyseekdb, and necessary considerations.

• File Path: 400.guides/400.deploy/700.server-mode/100.deploy-by-systemd.md

  • Description: This document provides instructions for deploying and managing the seekdb database using systemd on RPM-based, DEB-based, and macOS systems, covering installation, configuration, connection, and removal procedures.

• File Path: 400.guides/400.deploy/700.server-mode/200.deploy-by-docker.md

  • Description: This document provides instructions for deploying and configuring the seekdb database using Docker containers, including image sources, startup commands, environment variables, and data persistence options. It also covers connecting to the instance and accessing the obshell dashboard.

• File Path: 400.guides/400.deploy/700.server-mode/300.deploy-oceanbase-desktop.md

  • Description: This document provides instructions for deploying OceanBase Desktop on Windows or macOS, covering system requirements, installation steps, and connection methods for the graphical database management tool.

Upgrade

• File Path: 400.guides/460.upgrade/100.upgrading-via-mysqldump.md

  • Description: This document provides instructions for upgrading seekdb using mysqldump for logical migration, including backup and restore procedures with command examples and troubleshooting guidance.

Manage

• File Path: 400.guides/500.manage/100.configuration-management/100.configuration-management-introduction.md

  • Description: This document explains how seekdb manages configurations through system configuration items for operational control and system variables for session-level SQL behavior. It covers their scopes, modification methods, effective mechanisms, and query approaches.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/100.configuration-items-overview.md

  • Description: This document provides an overview of configuration items in seekdb, detailing parameter data types and methods for viewing and modifying settings. It explains the distinction between dynamic and restart-effective parameters and excludes hidden developer-only configuration items.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/200.view-parameters.md

  • Description: This document explains how to view configuration parameters in a database using either the SHOW statement to access non-hidden parameters or querying the GV$OB_PARAMETERS view to access all parameters including hidden ones. It provides syntax examples and result interpretations for both methods.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/300.modify-parameters.md

  • Description: This document explains how to modify dynamic and restart-effective parameters in seekdb using SQL commands, including viewing and updating values with scope options.

• File Path: 400.guides/500.manage/100.configuration-management/200.system-configuration-items/400.reset-parameters.md

  • Description: This document explains how to reset database parameters to their default values using the ALTER SYSTEM RESET statement, including the procedure and scope options for the reset.

• File Path: 400.guides/500.manage/100.configuration-management/300.system-variable/100.system-variable-overview.md

  • Description: Describes seekdb's system variables, which include global and session variables, and explains how to set and query them. It also differentiates system variables from system parameters.

• File 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 and database views, providing syntax examples and query results for both session and global variables.

• File 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 adjusting timeout settings and boolean variables.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/100.recyclebin-overview.md

  • Description: This document describes the recycle bin feature, which stores deleted databases, tables, and indexes. It covers supported objects, operational limitations, and the need to manually purge objects to free storage space.

• File 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 the system variable recyclebin, covering both global and session-level configuration methods.

• File 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 recycle bin using the SHOW RECYCLEBIN statement, including details on returned fields and prerequisites for querying dropped objects.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/400.restore-the-recyclebin-objects.md

  • Description: This document explains how to use the FLASHBACK statement to restore databases and tables from the recycle bin, including considerations for renaming objects and restoring dependencies.

• File Path: 400.guides/500.manage/200.high-availability/200.recyclebin/500.purge-the-recyclebin.md

  • Description: This document explains how to manually or automatically purge the recycle bin in seekdb to clean up data from deleted database objects. It provides step-by-step procedures for using the PURGE command and configuring automatic expiration.

• File 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 undo_retention parameter and AS OF SNAPSHOT syntax to retrieve historical data versions. It covers prerequisites, configuration steps, usage examples, and important considerations for storage and DDL operations.

• File Path: 400.guides/500.manage/300.security/100.security-overview.md

  • Description: This document outlines seekdb's enterprise-level security features including identity authentication, access control, and data encryption to protect database systems and ensure data security.

• File Path: 400.guides/500.manage/300.security/200.identification-and-authentication/100.identification.md

  • Description: Describes user identification and authentication in seekdb, including how the MySQL Authentication Protocol verifies credentials and controls database access based on username, client IP, and password.

• File 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, including setting system variables for length, character requirements, and policy levels to enhance database security.

• File 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 exceeding a configurable threshold of failed attempts, including details on lockout duration calculation and configuration examples.

• File Path: 400.guides/500.manage/300.security/300.access-control/100.access-control-overview.md

  • Description: This document outlines seekdb's access control system, covering permission management through user and role verification strategies and network security via allowlists to restrict database access.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/100.permission-classification.md

  • Description: This document outlines the permission types in seekdb, detailing global, database, and object-level privileges and their specific capabilities. It provides a comprehensive reference for managing user access and system operations.

• File 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 users in the database, including required privileges, username rules, and the CREATE USER statement syntax with examples for minimal privilege assignment.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/200.direct-authority.md

  • Description: This document explains how to use the GRANT statement to directly assign privileges to users, covering syntax, prerequisites, and examples for global, database, table, and column-level permissions.

• File 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 delegate authority in a database system using the with grant option parameter, allowing users to grant their privileges to others while noting that delegated authorities persist even if the original grant is revoked.

• File 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 combine permissions and can be granted to users or other roles. It also references detailed procedures for creating, managing, and deleting roles.

• File 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 using the CREATE ROLE statement, including prerequisites, syntax examples, and optional clauses. It also covers related actions like granting privileges and roles.

• File 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 various privileges to a role using the GRANT statement, including system, database, table, and column-level permissions. It also outlines the prerequisite privileges required to perform these actions.

• File 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 roles to users or other roles, including prerequisites, syntax examples, and administrative options for delegation. It also covers activating granted roles and provides references for further details.

• File 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 manage role activation in sessions, including setting default roles at login and using statements to control activated roles within a current session.

• File 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 privileges for users and roles, including default and active roles, using SQL statements and system views. It also covers querying authorization relationships and specific privileges at the table, column, and routine levels.

• File 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, including required prerequisites and syntax examples for revoking system, database, table, and column-level privileges.

• File 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 roles from users or other roles, including prerequisites, considerations, and multiple syntax examples.

• File 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 roles using the DROP ROLE statement, including required privileges, automatic revocation from users, and deletion examples.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/350.indirect-authority.md

  • Description: This document explains how users can obtain privileges indirectly through role grants, covering prerequisites, examples, and session activation requirements for using role-based permissions.

• File 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 like mysql.user, mysql.db, and information_schema.COLUMN_PRIVILEGES, including required prerequisites and detailed procedures.

• File Path: 400.guides/500.manage/300.security/300.access-control/200.user-and-permission/50.user-and-permission-overview.md

  • Description: This documentation outlines seekdb's user management and permission system, covering user roles, three-tiered permissions (global, database, and object levels), permission delegation, and permission inheritance through roles. It also explains how permissions are checked during SQL operations and specific scenarios requiring direct permissions.

• File 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 at various levels, including global, database, table, and column permissions. It covers prerequisites, important considerations, and provides practical examples for each scenario.

• File 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 and unlock user accounts in seekdb using SQL statements, including prerequisites and verification steps. It covers the required privileges and provides examples for both locking and unlocking procedures.

• File 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 users using the DROP USER statement, including required privileges and deletion procedures. It also notes that user deletion does not remove associated databases or objects.

• File 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 whitelist feature and the global system variable ob_tcp_invited_nodes. It covers viewing and setting whitelist values, which support exact, fuzzy, and mask-based IP matching.

• File Path: 400.guides/500.manage/300.security/400.data-transfer-encryption/100.data-transfer-encryption-overview.md

  • Description: This document outlines how seekdb implements data transfer encryption using SSL/TLS protocols to secure communications between its components and MySQL connections. It details the available authentication mechanisms, including one-way and various two-way SSL authentication methods.

• File Path: 400.guides/500.manage/300.security/400.data-transfer-encryption/200.seekdb-transmission-encryption.md

  • Description: This document provides procedures for enabling transmission encryption in seekdb components, covering SSL configuration for MySQL and RPC ports along with verification methods to confirm encryption status.

Reference

This category contains reference documentation for seekdb including MySQL compatibility, SQL syntax, PL, error codes, SDK, and telemetry.

Mysql Compatibility

• File Path: 450.reference/100.mysql-compatibility/100.mysql-compatibility.md

  • Description: This document details seekdb's compatibility with MySQL 5.7 and 8.0, covering supported data types, SQL syntax, PL features, character sets, collations, functions, partitioning, storage engine, and optimizer, while noting specific limitations and architectural differences.

Sql

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/100.data-type-overview.md

  • Description: This chapter provides an overview of seekdb's supported data types, including numeric, string, JSON, spatial, and specialized types, along with their properties, storage requirements, and comparison rules.

• File 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: An efficient compressed bitmap data type for storing and processing sets of unsigned integers, offering high space efficiency and fast operations for data analysis and queries. It excels with sparse data and supports 64-bit integers.

• File 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 and considerations for viewing binary results.

• File 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 (ARRAY) in seekdb, detailing supported element types and common use cases for storing and processing multiple values of the same type. It also notes limitations and references additional array functions.

• File 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, considerations, and examples for defining and populating arrays.

• File 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 seekdb's map data type, which stores unordered key-value pairs for managing configuration options, user attributes, and product information. It covers supported data types for keys and values, current limitations, and available functions for data extraction and manipulation.

• File 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 using the CREATE TABLE statement, including syntax examples, considerations like the inability to set default values, and supported nested data types.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/100.numeric-type.md

  • Description: This document details seekdb's numeric data types, including integer, fixed-point, floating-point, and bit-value types, along with their attributes like ZEROFILL for display formatting.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/200.integer-type.md

  • Description: This documentation covers integer data types in seekdb, including their storage lengths, value ranges, and usage syntax. It details specific types like TINYINT, BOOLEAN, SMALLINT, MEDIUMINT, INT, BIGINT, and SERIAL with their display widths and attributes.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/300.fixed-point-type.md

  • Description: Fixed-point types are exact numeric types with variable precision and scale, including DECIMAL, NUMERIC, and FIXED synonyms. They support optional unsigned and zerofill attributes with maximum precision of 65 digits and scale of 30 digits.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/400.floating-point-type.md

  • Description: Floating-point types are fixed-length, non-precise numeric types with value ranges and precision determined by type length, precision, and scale. The documentation covers FLOAT and DOUBLE types, their syntax, storage characteristics, and practical precision considerations.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/200.numeric/500.bit-value-type.md

  • Description: Stores bit values with optional length specification, supporting zero-padding for values shorter than the specified bit length. The BIT(M) type accepts values from 1 to 64 bits, defaulting to 1 bit when length is omitted.

• File 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: Describes seekdb's date and time data types, including DATETIME, TIMESTAMP, DATE, TIME, and YEAR, detailing their formats, value ranges, and scale attributes for precision.

• File 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, covering their storage formats, value ranges, syntax, and key differences including fractional second precision and time zone handling for TIMESTAMP.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/300.time-type.md

  • Description: The TIME type represents time of day or intervals up to 838 hours, supporting fractional seconds with microsecond precision. Values can be assigned using strings or numbers and are displayed in 'hh:mm
    .fraction
    ' format.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/300.date-and-time-types/400.year-type.md

  • Description: The YEAR type represents years in 4-digit format (1901-2155, plus 0000), supporting input as strings, numbers, or expressions with automatic conversion rules for different digit formats.

• File 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 the string data types in seekdb, including CHAR, VARCHAR, BINARY, and VARBINARY. It details their length types, maximum lengths, and supported character sets.

• File 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 explains the differences between CHAR and VARCHAR data types, covering their storage methods, maximum lengths, and handling of trailing spaces during storage and retrieval. It also provides syntax examples and implementation details for both data types.

• File 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, which store binary byte strings instead of character strings. It covers their syntax, length specifications, storage behaviors including padding and truncation, and comparison operations.

• File 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: Describes seekdb's BLOB and TEXT data types for storing large objects and text, including their storage capacities, character sets, and key differences from VARBINARY/VARCHAR types.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/200.blob-type.md

  • Description: The BLOB type stores variable binary data with four subtypes (TINYBLOB, BLOB, MEDIUMBLOB, LONGBLOB) differing in maximum byte capacity. Values are treated as binary strings where comparisons use numeric byte values, and truncation behavior depends on SQL strict mode settings.

• File 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 and its variants (TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT) for storing text data, including their maximum lengths, storage requirements, character set specifications, and behavior during data insertion under different SQL modes.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/350.string-type.md

  • Description: The STRING type supports variable-length text up to 16 MB and can serve as a primary key or index column, with storage behavior determined by whether it's a primary key and the LOB_INROW_THRESHOLD value. It includes specific limitations for indexing, partitioning, and data loading scenarios.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/500.large-object/400.lob-type.md

  • Description: This document explains LOB data types for storing large objects like text, JSON, and binary data, detailing inline and out-of-line storage methods and their performance implications. It also lists specific LOB types with their characteristics and storage thresholds.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/100.data-type/600.enum-type.md

  • Description: The ENUM type defines a string object with a fixed set of possible values, stored internally as integers for efficient data compression. It supports up to 65,535 elements, uses UTF8MB4 character encoding, and provides readable string outputs in query results.

• File 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 variable-length string object that stores zero or more values from a predefined list. It covers syntax, character set support, internal representation, storage mechanics, and sorting behavior.

• File 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 outlines JSON data type support in seekdb, covering validation, storage optimization, and efficient access methods for semi-structured data. It includes references to JSON functions and value creation.

• File 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 explains the structure and syntax of JSON values and describes how to create and manage JSON columns in seekdb, including DDL operations, indexing on generated columns, and enabling semi-structured encoding for performance optimization.

• File 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 explains how to query and modify JSON values in seekdb using path expressions, including operators for referencing key-value pairs and functions for updating partial data. It also details the JSON path syntax for extracting or modifying specific parts of a JSON document.

• File 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 details the CAST function for converting between JSON and other data types in seekdb, including conversion rules and examples for handling character sets, NULL values, and scalar conversions.

• File 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 explains how to enable and use JSON partial updates in seekdb, allowing selective modification of JSON document fields without rewriting entire documents. It covers configuration, supported expressions, update granularity, and storage considerations.

• File 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 outlines the spatial data types supported by seekdb's GIS feature, including basic geometry types and their multi-part collection counterparts. It explains the hierarchical relationships between these types and their specific use cases for storing geographic data.

• File 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 explains spatial reference systems (SRS) including projected and geographic types, details the default SRID 0 unitless Cartesian plane, and demonstrates how to retrieve SRS metadata from system tables.

• File 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 explains how to create spatial columns using SQL statements, detailing the syntax for CREATE TABLE and ALTER TABLE operations. It also covers the constraints for defining SRID values and spatial indexes.

• File 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 spatial indexes in seekdb, covering requirements like NOT NULL columns and SRID definitions, and provides syntax examples for creating indexes on stored generated columns and regular geometry columns.

• File 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 details the two spatial data formats supported by seekdb, Well-Known Text (WKT) and Well-Known Binary (WKB), including their syntax, geometric object types, validity rules, and usage examples for queries and data insertion.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/200.expression/100.expression-overview.md

  • Description: This document provides an overview of expressions, which are combinations of parameters that return a result. It covers expression types, components, and their usage in SQL statements.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/200.expression/200.expression-syntax.md

  • Description: This document outlines the expression syntax rules for seekdb, covering logical, comparison, and arithmetic operators along with predicates and simple expressions. It provides the formal grammar structure for constructing valid expressions in the system.

• File 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 both implicit and explicit conversion methods. It details conversion behaviors for comparison operators, type downgrading scenarios, and non-standard comparison handling.

• File 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 outlines SeekDB's character set and collation support, detailing how to store and compare strings in various encodings and define these settings at the database, table, or column level.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/200.character-set.md

  • Description: This document details the character sets supported by seekdb, including utf8mb4 as the default, and explains how to specify non-default character sets for server communication. It also covers viewing available character sets and notes on encoding conversion between gb18030 and gb18030_2022.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/300.character-set-and-collation/300.collation.md

  • Description: Lists the character sets and collations supported by seekdb, including the default utf8mb4_general_ci and various language-specific and binary collations.

• File 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 manage character sets and collations at the database level in seekdb, covering the syntax for CREATE DATABASE and ALTER DATABASE statements along with the rules for character set and collation selection.

• File 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 set and modify the default character set and collation for database tables using CREATE TABLE and ALTER TABLE statements, including syntax examples and selection rules.

• File 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 set and manage character sets and collations at the column level in SQL, covering syntax for CREATE TABLE and ALTER TABLE statements, rules for automatic selection, and conditions for converting existing column character sets.

• File 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 sets and collations are assigned to character expressions in SQL statements, detailing the syntax rules for explicit specification and the default behaviors when no character set or collation is explicitly defined.

• File 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 managed for client-server connections, detailing the relevant system variables and SQL statements for configuring character handling during database interactions.

• File 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, covering the fixed values used in functions, SQL statements, expressions, and conditions. It details the supported literal types including string, numeric, date/time, bit, boolean, and NULL values.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/200.string-literal.md

  • Description: Explains string literals in SQL, covering binary/non-binary types, character sets, collation, and escape sequences. Includes details on ANSI_QUOTES mode and practical syntax examples.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/300.numeric-value.md

  • Description: This document describes numeric value formats, covering decimal values (exact and approximate) and hexadecimal values with their syntax, examples, and usage considerations.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/400.date-and-time.md

  • Description: This documentation covers date and time value formats in seekdb, including string and numeric literals for DATE, DATETIME, TIMESTAMP, and TIME data types with supported separators and validation rules.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/500.hexadecimal-numeric.md

  • Description: This document explains the syntax and usage of bit values in seekdb, including valid formats and default binary string behavior. It covers how bit values are treated as integers in expressions and demonstrates conversion methods.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/600.boolean.md

  • Description: This document covers Boolean values including the constants TRUE and FALSE, which evaluate to 1 and 0 respectively, and notes that constant names are case-insensitive.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/400.literal/700.null-value.md

  • Description: Explains the concept of NULL values, their synonyms, and how they are treated in ordering operations and data import/export statements.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/500.schema-object-name.md

  • Description: This document covers schema object naming conventions, including identifier quotation rules and character restrictions. It also explains how to use qualifiers for different object types like databases, tables, and columns.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/600.custom-variables.md

  • Description: This document explains user-defined variables in SQL, covering syntax, assignment methods, data types, and session-specific behavior. It also details compatibility considerations and limitations when using variables in different SQL contexts.

• File Path: 450.reference/200.sql/100.sql-syntax/100.basic-elements/700.annotation.md

  • Description: This document details seekdb's comment syntax for SQL statements and database objects, covering single-line (#, --) and multi-line (/* /) comments, version-specific execution (/! */), and DDL COMMENT clauses for object annotations.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/100.operator-overview.md

  • Description: This document provides an overview of operators, explaining their syntax and classification into unary and binary types. It lists the specific operator categories supported, including arithmetic, bitwise, comparison, logical, date/time, and character concatenation operators.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/1000.binary-conversion-operators.md

  • Description: This document explains the BINARY conversion operator in seekdb, which converts expressions to binary strings for case-sensitive and whitespace-aware string comparisons. It also covers equivalent conversion methods and clarifies distinctions between the BINARY operator and BINARY column definitions.

• File 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 without subprograms. It covers two syntax variations and includes practical examples demonstrating conditional value comparisons and result returns.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/200.operator-precedence.md

  • Description: This document outlines the operator precedence hierarchy for seekdb, covering arithmetic, bitwise, comparison, logical, date/time, string concatenation, and collation operators. It includes special notes about precedence variations for assignment versus comparison operators and SQL mode dependencies.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/300.arithmetic-operators.md

  • Description: This document details the arithmetic operators supported in seekdb, including unary and binary operations, integer division, and modulus, along with rules for operand types and result precision.

• File 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, and logical shifts, all operating on unsigned 64-bit integers.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/500.comparison-operators.md

  • Description: This document details the comparison operators supported by seekdb, including their syntax, operand requirements, and behavior when handling NULL values.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/600.logical-operators.md

  • Description: This document describes the logical operators supported by seekdb, including NOT, AND, OR, and XOR, along with their syntax, behavior, and limitations.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/700.assignment-operator.md

  • Description: Covers the assignment operators := and = in seekdb, explaining their usage in SET statements, UPDATE clauses, and other SQL contexts with examples.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/800.date-and-time-operators.md

  • Description: This document covers date and time operators in seekdb, detailing binary addition and subtraction operators that correspond to DATE_ADD and DATE_SUB functions.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/900.character-concatenation-operators.md

  • Description: This document covers the character concatenation operators in seekdb, including the || operator and its behavior based on the sql_mode parameter.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/100.function-overview.md

  • Description: This document provides an overview of seekdb's built-in functions, including single-row, aggregate, analytic, encryption, and specialized functions for JSON, XML, spatial data, arrays, and other data types. It covers function categories, behaviors, and usage guidelines.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/100.any-value.md

  • Description: The ANY_VALUE function suppresses ONLY_FULL_GROUP_BY errors by selecting a value from the first row in each group, allowing queries with non-aggregated columns in GROUP BY operations. It returns the same type as its parameter while bypassing deterministic value requirements.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1400.inet-aton.md

  • Description: Converts IPv4 addresses from string to unsigned integer format using network byte order. Returns NULL for invalid inputs and requires UNSIGNED INT columns for proper storage.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1500.inet-ntoa.md

  • Description: Converts IPv4 network addresses from integer format to dotted-quad string notation, returning NULL for invalid inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1600.inet6-aton.md

  • Description: Converts IPv6 or IPv4 network addresses to binary strings in network byte order, returning VARBINARY(16) for IPv6 and VARBINARY(4) for IPv4 addresses. Returns NULL for invalid addresses and has specific limitations regarding zone IDs, network masks, and address formats.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1700.inet6-ntoa.md

  • Description: Converts numeric IPv6 or IPv4 network addresses into binary strings, returning NULL for invalid inputs. The platform-independent function produces lowercase IPv6 strings with a maximum length of 39 characters.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1800.is-ipv4.md

  • Description: Tests whether an expression is a valid IPv4 address string, returning 1 for valid addresses and 0 otherwise. This function has stricter validation requirements than INET_ATON() for IPv4 address checking.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/1900.is-ipv4-compat.md

  • Description: Tests whether an IPv6 address is IPv4-compatible, returning 1 for valid addresses in the format ::ipv4_address and 0 otherwise.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/200.bin-to-uuid.md

  • Description: Converts a binary UUID value to a string UUID, with an optional flag to swap the time low and time high parts. The function returns a formatted UUID string or NULL if the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2000.is-ipv6.md

  • Description: Returns 1 if the input expression is a valid IPv6 address string, otherwise returns 0. Does not recognize IPv4 addresses as valid IPv6 addresses.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2200.is-uuid.md

  • Description: Validates UUID strings by checking correct format and allowed characters, returning 1 for valid UUIDs, 0 for invalid, and NULL for NULL inputs. Supports multiple UUID formats including hyphenated, non-hyphenated, and brace-enclosed variations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2250.match-against.md

  • Description: This document explains the MATCH AGAINST expression for full-text search, detailing its syntax, parameters, and usage for relevance scoring, filtering, and sorting in text retrieval operations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2300.nvl.md

  • Description: The NVL function replaces NULL values with a specified alternative, which can be a hard-coded value, column reference, or expression to ensure complete output.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2400.uuid-to-bin.md

  • Description: Converts a string UUID to a binary UUID, with an optional swap flag to rearrange time parts for improved index efficiency when storing version 1 UUIDs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2500.sleep.md

  • Description: Pauses execution for a specified number of seconds and returns 0, or returns 1 if interrupted. When used within queries, interruptions result in error code 1317.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2600.uuid.md

  • Description: Generates a globally unique identifier (UUID) using the uuid() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/2700.uuid-short.md

  • Description: Returns a 64-bit unsigned integer universal identifier with uniqueness guarantees under specific server configuration and usage conditions. The value combines server ID, startup time, and an incrementing variable to generate space-time unique identifiers.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/300.coalesce.md

  • Description: Returns the first non-NULL value from a list of expressions, or NULL if all expressions are NULL. All expressions must be of the same or compatible data types.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/3000.values.md

  • Description: This function is used exclusively in INSERT ... ON DUPLICATE KEY UPDATE statements to reference column values from the INSERT portion within the UPDATE clause. It returns NULL in all other contexts.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/400.default.md

  • Description: Returns the default value of a specified column, returning NULL if no default exists. This function is used to retrieve or reset column values to their predefined defaults.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/1000.other-functions/500.name-const.md

  • Description: This function returns a specified constant value while naming the resulting column in the output. It provides an alternative method to column aliasing for defining result set column names.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/100.adddate.md

  • Description: This function adds a specified time interval or number of days to a date. It supports both INTERVAL syntax and direct day addition, functioning as a synonym for DATE_ADD in its first form.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1000.date-format.md

  • Description: Formats a date and time value according to specified format codes, supporting various components like day names, months, years, hours, minutes, and seconds.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1100.date-sub.md

  • Description: Subtracts a specified time interval from a date or datetime value, supporting various units from microseconds to years. The function accepts both independent and combined interval units for flexible date calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1200.datediff.md

  • Description: Calculates the number of days between two dates, ignoring time components.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1300.dayofmonth.md

  • Description: Returns the day of the month from a given date or datetime value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1400.dayofweek.md

  • Description: Returns the position of a date in the week, starting from Sunday.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1500.dayofyear.md

  • Description: Returns the day of the year (1-366) for a given date or datetime value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1600.extract.md

  • Description: Returns the specified unit from a date value as an integer, supporting multiple units concatenated when specified. The function uses Sunday as the first day of the week when extracting week values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1700.from-days.md

  • Description: Converts a numeric day count into a date value starting from the year 0000-01-01.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1800.from-unixtime.md

  • Description: Converts a Unix timestamp to a datetime value, either as a standard DATETIME or as a formatted string when a format pattern is provided.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/1900.get-format.md

  • Description: Returns format strings for date/time values according to specified regional standards (EUR, USA, JIS, ISO, INTERNAL) for use with DATE_FORMAT and STR_TO_DATE functions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/200.convert-tz.md

  • Description: Converts datetime values between specified time zones, returning NULL for invalid inputs. Handles TIMESTAMP range limitations during timezone conversion.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2000.hour.md

  • Description: Extracts the hour component from a time value and returns it as a numeric value, supporting both standard and extended time formats.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2100.last-day.md

  • Description: Returns the date value of the last day of the month for a given date input.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2200.localtime.md

  • Description: Returns the current date and time, with optional microsecond precision specified by a scale parameter from 0 to 6. This function is a synonym for NOW().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2300.localtimestamp.md

  • Description: Returns the current date and time with optional microsecond precision. This function is a synonym for NOW() and accepts a scale parameter from 0 to 6 to specify fractional second digits.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2400.makedate.md

  • Description: Converts a year and day-of-year value into a date, returning NULL for invalid inputs. Handles day values beyond 366 by incrementing the year, but returns NULL if the resulting year exceeds 9999.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2500.maketime.md

  • Description: Returns a time value from specified hour, minute, and second parameters, including support for decimal seconds.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2600.microsecond.md

  • Description: Returns the microseconds portion from a time or datetime expression. Extracts values ranging from 0 to 999999 microseconds.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2700.minute.md

  • Description: Returns the minute number from a given time value. Extracts the minute component (0-59) from time expressions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2800.month.md

  • Description: Returns the month value from a given date.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/2900.monthname.md

  • Description: Returns the full name of the month for a specified date.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/300.curdate.md

  • Description: Returns the current date without the time component.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3000.now.md

  • Description: Returns the current date and time with timezone awareness, allowing optional microsecond precision scaling from 0 to 6. This function serves as an alias for CURRENT_TIMESTAMP().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3100.period-add.md

  • Description: Adds N months to a period P in YYMM or YYYMM format, returning the result in YYYYMM format. The period parameter cannot be a DATE value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3200.period-diff.md

  • Description: Calculates the number of months between two periods specified in YYYMM or YYMM format. The function returns the interval as an integer value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3300.quarter.md

  • Description: Returns the quarter value (1-4) of a specified date.

• File 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: Converts a specified number of seconds into a time value, with results constrained to the valid range of the TIME data type.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3500.second.md

  • Description: Returns the number of seconds from a given time value.

• File 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: Converts a string to a DATETIME, DATE, or TIME value using a specified format, returning NULL for invalid inputs or depending on sql_mode settings.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3700.subdate.md

  • Description: Subtracts a specified time interval or number of days from a date or datetime expression. Functions as a synonym for DATE_SUB when using INTERVAL syntax.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3800.subtime.md

  • Description: Calculates the difference between two time or datetime expressions and returns the result formatted to match the first expression.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/3900.sysdate.md

  • Description: Returns the current date and time with optional fractional second precision, supporting values from 0 to 6 digits.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/400.current-date.md

  • Description: Returns the current date without time information. This function is an alias for CURDATE.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4000.time.md

  • Description: Extracts the time component from a datetime value, returning it as a TIME data type.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4100.time-format.md

  • Description: Formats time values using hour, minute, second, and microsecond format specifiers, with special handling for hours exceeding 23. Similar to DATE_FORMAT but limited to time-specific formatting options.

• File 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: Converts a time value to its total number of seconds.

• File 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: Converts date or datetime values to microseconds since the Unix epoch, accounting for timezone.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4400.timediff.md

  • Description: Calculates the time interval between two datetime values, returning the result as a TIME data type.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4500.timestamp.md

  • Description: Returns datetime values from expressions or adds time expressions to datetime values, returning NULL if any parameter is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4600.timestampadd.md

  • Description: Performs date and time arithmetic by adding or subtracting specified intervals (such as days, months, or years) from a given timestamp.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4700.timestampdiff.md

  • Description: Calculates the time difference between two dates in specified units. Supports the same time units as the DATE_ADD function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/4800.to-days.md

  • Description: Calculates the number of days since January 1, 0000 for a given date value. Accepts date inputs in various formats and returns an integer representing the day count.

• File 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 function calculates the number of seconds since year 0 for a given expression, returning NULL if the input is NULL. It accepts both numeric and date string inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/500.current-time.md

  • Description: Returns the current time without the date component, with optional microsecond precision specified by a scale parameter from 0 to 6.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5000.unix-timestamp.md

  • Description: Returns the number of seconds between a specified date/time and the Unix epoch (1970-01-01 00:00:00), accounting for time zone. Can be used with or without a date parameter to return current or specified timestamps.

• File 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: Converts microseconds since the Unix epoch into a UTC timestamp value. The function requires a microsecond input and outputs a TIMESTAMP type with UTC timezone consideration.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5200.utc-date.md

  • Description: Returns the current UTC date in YYYY-MM-DD format, with examples of date arithmetic operations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5300.utc-time.md

  • Description: Returns the current UTC time in a standard format, with an optional parameter to specify fractional seconds precision.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5400.utc-timestamp.md

  • Description: Returns the current UTC timestamp in YYYY-MM-DD HH:MM:SS format, with optional fractional seconds precision from 0 to 6.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5500.week.md

  • Description: Returns the week number of a given date within the year, with an optional mode parameter to specify different week numbering conventions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5600.weekday.md

  • Description: Returns the position of a date value in the week, with values ranging from 0 to 6.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5700.weekofyear.md

  • Description: Returns the week number of the year for a given date or time value. The function calculates the position of the week within the year based on the provided date.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5800.yearweek.md

  • Description: Returns the year and week number for a date, with an optional mode parameter to specify week calculation logic. Supports multiple week numbering systems based on different first-day-of-week and range conventions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/5900.year.md

  • Description: Extracts the year component from a date value, returning it as a four-digit integer.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/600.current-timestamp.md

  • Description: Returns the current date and time in the local time zone with optional microsecond precision. Accepts a scale parameter from 0 to 6 to specify fractional second accuracy.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/6100.addtime.md

  • Description: Adds a time expression to a time or datetime value and returns the result. Supports microsecond precision in calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/6200.dayname.md

  • Description: Returns the name of the weekday for a given date.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/6300.day.md

  • Description: Extracts the day of the month (1-31) from a date value. This function is an alias for DAYOFMONTH().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/700.curtime.md

  • Description: Returns the current time without the date part, with optional microsecond precision from 0 to 6. This function is an alias for CURRENT_TIME().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/800.date.md

  • Description: Extracts the date component from a time or datetime expression, returning only the year, month, and day portion.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/100.date-and-time-functions/900.date-add.md

  • Description: Adds a specified time interval to a date or datetime value, supporting various units from microseconds to years. Returns the resulting date or datetime.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/100.ascii.md

  • Description: Returns the ASCII code of the leftmost character in a string, returning 0 for empty strings and NULL for NULL inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/1800.elt.md

  • Description: Returns a string from a list based on a numeric index, where N=1 returns the first string, N=2 the second, and so on. Returns NULL if the index is out of range or invalid.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/1900.export_set.md

  • Description: Returns a string representing the bits of a value, replacing each set bit with the 'on' string and each unset bit with the 'off' string. The output is separated by a specified delimiter and checks a configurable number of bits from least to most significant.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/200.bin.md

  • Description: Returns the binary representation of a number, equivalent to CONV(N,10,2). Returns NULL if the input number is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/2000.field.md

  • Description: Returns the index position of a value within a list of parameters, starting from 1. Compares values as strings, numbers, or doubles depending on parameter types and returns 0 if the value is not found or NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/2100.find_in_set.md

  • Description: This function returns the position of a string within a comma-separated list, starting from 1. It returns 0 if the string is not found and NULL if either input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/2200.format.md

  • Description: Formats a number with thousand separators and rounds it to a specified number of decimal places, returning the result as a string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/300.bit-length.md

  • Description: Returns the bit length of a specified string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3300.hex.md

  • Description: Converts a number or string to a hexadecimal string representation, with each byte of the input transformed into two hexadecimal digits.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3400.insert.md

  • Description: Replaces a substring in a string starting at a specified position with a given length, supporting multibyte characters and returning NULL for any NULL arguments.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3500.instr.md

  • Description: Returns the first occurrence of a substring within a string, equivalent to the reversed two-argument LOCATE() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3600.int2ip.md

  • Description: Converts integer values to IP addresses using a specific calculation method, returning NULL for values exceeding 4294967295 or NULL inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3700.ip2int.md

  • Description: Converts an IP address string into its integer equivalent using a specific mathematical formula. The function handles standard dotted-decimal IP format and returns a numeric value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/3750.keyvalue.md

  • Description: Extracts values from key-value pair strings using customizable delimiters to separate pairs and keys from values. Returns NULL if parameters are invalid or the key isn't found.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/400.char.md

  • Description: Converts integer parameters to corresponding characters, skipping NULL values and handling values over 255 as multiple bytes. Supports character set specification with the USING clause and returns NULL for invalid characters in strict SQL modes.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/4800.lcase.md

  • Description: Converts uppercase letters in a string to lowercase, serving as a synonym for the LOWER() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/4900.left.md

  • Description: Returns the leftmost specified number of characters from a string, handling multibyte characters and returning NULL for NULL inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/500.char-length.md

  • Description: Returns the number of characters in a string, counting multi-byte characters as single units. Provides the character length rather than byte length of input strings.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5000.length.md

  • Description: Returns the length of a string in bytes, counting multibyte characters as multiple bytes.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5100.locate.md

  • Description: Returns the position of the first occurrence of a substring within a string, with an optional starting position parameter. Returns 0 if the substring is not found.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5200.lower.md

  • Description: Converts uppercase letters in a string to lowercase, serving as a synonym for the LCASE() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5300.lpad.md

  • Description: Pads a string on the left with a specified string to reach a target length, truncating the original string if it exceeds the target length.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5400.ltrim.md

  • Description: Removes leading spaces from the left side of a string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5500.make-set.md

  • Description: Returns a comma-separated list of strings corresponding to bits set to 1 in the input value, with string positions mapped to binary bit positions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5550.md5-concat-ws.md

  • Description: This function generates an MD5 hash from concatenated strings using a specified separator, replacing NULL values with a designated replacement string before hashing.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5600.mid.md

  • Description: Extracts a substring from a string starting at a specified position with an optional length. This function handles negative positions and edge cases while being an alias for SUBSTRING.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5700.oct.md

  • Description: Returns the octal value of a decimal number, equivalent to CONV(N,10,8). Returns NULL if the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5800.octet-length.md

  • Description: OCTET_LENGTH() is a synonym for LENGTH() function that returns the number of bytes in a given string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/5900.ord.md

  • Description: Returns the ASCII value of the leftmost character in a string, handling both single-byte and multibyte characters with specific calculation methods for multibyte cases.

• File 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 function, which is a synonym for CHAR_LENGTH and returns the number of characters in a string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/6000.position.md

  • Description: Returns the starting position of the first occurrence of a substring within a string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/700.concat.md

  • Description: Concatenates multiple strings into a single string, returning NULL if any parameter is NULL. Handles binary strings and numeric conversions automatically.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7000.quote.md

  • Description: Escapes and quotes strings for safe use in SQL statements by adding necessary backslashes and enclosing in single quotes. Returns the string 'NULL' without quotes when the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7100.regexp.md

  • Description: This document covers the REGEXP and RLIKE operators for pattern matching in SQL, including syntax, behavior with NULL values, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7200.regexp-instr.md

  • Description: Returns the starting position of a substring matching a regular expression pattern in a given string, with optional parameters for search position, occurrence, return type, and matching rules.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7300.regexp-like.md

  • Description: Tests whether a string matches a regular expression pattern, returning 1 for true and 0 for false. Supports optional matching modes for case sensitivity and newline handling.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7400.regexp-replace.md

  • Description: Replaces substrings matching a regular expression pattern with a specified replacement string, with optional parameters for starting position, occurrence, and match rules.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7500.regexp-substr.md

  • Description: Extracts a substring matching a regular expression pattern from a string, supporting multi-byte characters and optional parameters for position, occurrence, and subexpression matching. Returns NULL if no match is found.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7600.repeat.md

  • Description: Returns a string consisting of the input string repeated a specified number of times, returning an empty string for non-positive counts and NULL for NULL parameters.

• File 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() function, which replaces all occurrences of a specified substring in a string with another substring. It covers syntax, parameters, case sensitivity, NULL handling, and includes practical usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7800.reverse.md

  • Description: Returns the reverse of a given string, supporting both text and numeric inputs. This multibyte-safe function handles character reversal for various data types.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/7900.right.md

  • Description: Returns the rightmost specified number of characters from a string. The function is multibyte-safe and returns NULL if either input parameter is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/800.concat-ws.md

  • Description: Concatenates multiple strings with a specified separator between them, ignoring NULL values while preserving empty strings.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8000.rlike.md

  • Description: Tests whether a string matches a regular expression pattern, returning 1 for matches and 0 for non-matches, with NULL handling for null inputs. This function is a synonym for REGEXP().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8100.rpad.md

  • Description: Pads a string on the right side with a specified padding string until reaching a target length, truncating the original string if it exceeds the target length.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8200.rtrim.md

  • Description: Removes trailing spaces from a string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8300.space.md

  • Description: Returns a string containing a specified number of spaces. The function takes a single numeric parameter to determine the number of spaces in the output string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8350.split_part.md

  • Description: Splits a string using a delimiter and returns the substring at a specified position, with optional support for negative indexing and range extraction.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8400.strcmp.md

  • Description: Compares two string expressions and returns 0 if identical, -1 if the first is a substring of the second, or 1 if the second is a substring of the first.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8500.substr.md

  • Description: Returns a substring from a string starting at a specified position, with optional length. Handles negative positions, invalid inputs, and NULL values according to defined rules.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8600.substring.md

  • Description: Extracts a substring from a string starting at a specified position, with optional length parameter. Returns NULL for NULL inputs and empty strings for invalid positions or lengths.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8700.substring_index.md

  • Description: Extracts a substring from a string based on a specified delimiter occurrence, supporting both positive and negative count values to search from the start or end. Returns NULL for NULL parameters and empty strings for invalid inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8800.trim.md

  • Description: Removes leading and/or trailing characters from strings, with options for BOTH, LEADING, or TRAILING removal. Returns NULL if any parameter is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/8900.ucase.md

  • Description: Converts lowercase letters in a string to uppercase. This function is a synonym for UPPER().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9000.unhex.md

  • Description: Converts hexadecimal strings to binary data, returning NULL for non-hexadecimal input. Includes usage notes about binary columns and numeric parameter handling.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9100.upper.md

  • Description: Converts lowercase letters in a string to uppercase. The UPPER function transforms all lowercase characters in the input string to their uppercase equivalents.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9150.url_decode.md

  • Description: Decodes URL-encoded strings by converting percent-encoded hexadecimal sequences back to their original characters. Supports UTF-8 encoding and maintains input collation for string types.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9170.url_encode.md

  • Description: Encodes non-ASCII characters in a string into ASCII format using percent-encoding, converting non-alphanumeric characters into hexadecimal digits preceded by a percent sign.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9200.weight-string.md

  • Description: This function returns the binary weight string used for string comparison and sorting, primarily for internal debugging of collations. It supports optional AS and LEVEL clauses to control type conversion and weight level specifications.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9300.to-base64.md

  • Description: Converts a string to base-64 encoded format, with corresponding decoding available through the FROM_BASE64 function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9400.from-base64.md

  • Description: Decodes base-64 encoded strings into binary strings, typically reversing the encoding performed by the TO_BASE64() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/200.string-functions/9500.soundex.md

  • Description: Converts input strings to phonetic codes representing pronunciation, enabling fuzzy matching and similarity searches in databases.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/100.cast.md

  • Description: Explicitly converts expressions between data types including CHAR, DATE, DATETIME, DECIMAL, JSON, and numeric types, with support for precision specifications and character set declarations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1000.scn-to-timestamp.md

  • Description: Converts a specified System Change Number (SCN) to a timestamp of the DATETIME type, commonly used with internal views like oceanbase.gv$ob_log_stat.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1500.timestamp-to-scn.md

  • Description: Converts a timestamp to its corresponding System Change Number (SCN) as a UINT64_T value. The function accepts DATETIME input and returns the SCN associated with that specific timestamp.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1600.to_char_character.md

  • Description: Converts character data to a VARCHAR string, returning NULL for NULL input values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1700.to_char_number.md

  • Description: Converts numeric values to VARCHAR strings with optional formatting for currency, scientific notation, Roman numerals, and other display requirements.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/1800.to_char_datetime.md

  • Description: Converts datetime values to VARCHAR strings with optional formatting parameters for customized output. Supports various date and time components including eras, time zones, and localized month/day names.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/200.convert.md

  • Description: The CONVERT function changes expressions between character sets or data types, with two syntax forms: one for character set conversion and another equivalent to CAST for type conversion.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/300.conversion-functions/300.decode-trace-id.md

  • Description: This function decodes trace IDs to reveal the originating server's IP address and port number for SQL requests, with equivalent information available in the GV$OB_SQL_AUDIT view.

• File 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 function, which returns the absolute value of a numeric expression. It covers the function's declaration, return behavior with different data types, and includes an example of its usage.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1000.cos.md

  • Description: Returns the cosine of a given radian value.

• File 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 function, which calculates the cotangent of a given input value. It includes the function declaration, a brief description, and an example demonstrating its usage.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1200.crc32.md

  • Description: Computes a 32-bit cyclic redundancy check value for a given string expression, returning NULL if the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1300.degrees.md

  • Description: Converts a value from radians to degrees, returning the result.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1400.exp.md

  • Description: Returns the value of the natural logarithm base e raised to the power of X.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1500.floor.md

  • Description: Returns the largest integer less than or equal to a given numeric expression, handling boolean comparisons and null inputs while converting strings to numbers. Results are returned as BIGINT values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1600.generator.md

  • Description: A table function that generates N consecutive rows without data, used for parallel operations and requiring additional expressions to produce actual values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1600.ln.md

  • Description: Returns the natural logarithm of a value, equivalent to LOG(X), and returns NULL with a warning for arguments less than or equal to zero.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1700.log.md

  • Description: Computes the natural logarithm of a number or the logarithm of a number with a specified base, returning NULL for invalid arguments.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1800.log10.md

  • Description: Returns the base-10 logarithm of a given value, handling negative inputs by returning NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/1900.log2.md

  • Description: Returns the base-2 logarithm of a number, handling negative inputs by returning NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/200.acos.md

  • Description: Returns the inverse cosine of a value, producing NULL for inputs outside the range [-1,1].

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2000.mod.md

  • Description: Describes the MOD function for calculating division remainders, including syntax, equivalent operators, and behavior with NULL or zero values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2100.neg.md

  • Description: This function performs negation operations on numeric expressions and boolean comparisons, returning the negated value of the operand. It converts boolean results to numeric values (1 for true, 0 for false) before applying negation.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2200.normal.md

  • Description: Generates floating-point numbers following a normal distribution using specified mean and standard deviation parameters. Requires constant values for mean and standard deviation, with a random generator function for non-constant output.

• File 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() function, which returns the mathematical constant π (pi). It includes the function declaration, a brief description, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2300.pow.md

  • Description: Returns the value of X raised to the power of Y, returning NULL if either input is NULL.

• File 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, which returns the value of X raised to the power of Y and serves as an alias for the POW function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2500.radians.md

  • Description: Converts angles from degrees to radians, returning the radian value of input X. Demonstrates usage with positive, negative, and zero degree values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2600.rand.md

  • Description: Generates random floating-point numbers between 0 and 1, with optional seed parameter for deterministic sequences. Can be used in various SQL clauses for randomization and sampling operations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2800.random.md

  • Description: Generates 64-bit integer pseudo-random values using the MT19937 algorithm, with an integer seed parameter to produce different random sequences. The function supports large-scale random number generation before repeating sequences.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/2900.randstr.md

  • Description: Generates a random alphanumeric string of specified length using various distribution functions, with customizable behavior for length and randomness. Returns NULL for invalid lengths and handles empty strings appropriately.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/300.asin.md

  • Description: Returns the inverse sine of a value, producing NULL for inputs outside the range [-1, 1].

• File 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 function, which returns a value rounded to the nearest integer or to a specified number of decimal places. It explains the rounding rules for exact and approximate values and provides syntax examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3100.sign.md

  • Description: Returns the sign of a numeric value as -1, 0, or 1 for negative, zero, and positive inputs respectively. Handles floating-point numbers, hexadecimal values, and returns NULL for NULL inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3200.sin.md

  • Description: Returns the sine of the given radians value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3300.sqrt.md

  • Description: Returns the square root of a given value. Handles both positive numbers and negative inputs by returning NULL for the latter.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3400.tan.md

  • Description: Returns the tangent of a given value in radians.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/3500.truncate.md

  • Description: This function truncates a number to a specified number of decimal places, including handling of zero and negative decimal place values.

• File 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 function, which returns the arctangent of a given value. It includes the SQL syntax, a functional description, and an example query with output.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/4000.uniform.md

  • Description: Returns a uniformly distributed integer or float between specified min and max values using a generation function. The output type depends on whether both min and max parameters are integers.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/500.atan2.md

  • Description: Computes the arctangent of two values X and Y, determining the result's quadrant based on both parameters' signs. This function is equivalent to ATAN(X,Y) and returns the angle in radians.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/5000.zipf.md

  • Description: Generates integer values following the Zipf distribution within a specified range using characteristic exponent s and a generator function. The function produces skewed distributions where higher s values increase distribution skewness.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/600.bit-count.md

  • Description: Returns the number of 1 bits in the binary representation of a number, returning NULL if the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/700.ceil.md

  • Description: Returns the smallest integer greater than or equal to a given expression, converting boolean comparisons to 1 or 0 and strings to numeric values when possible. Handles NULL inputs by returning NULL and outputs results as BIGINT values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/800.ceiling.md

  • Description: Returns the smallest integer greater than or equal to a given value, functioning as an alias for CEIL(). Handles numeric inputs, NULL values, and automatic type conversions with BIGINT return type.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/400.mathematical-functions/900.conv.md

  • Description: Converts numbers between bases 2 to 36, supporting both signed and unsigned values with string or integer inputs. Handles base conversions with error checking for invalid parameters or out-of-range values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/100.greatest.md

  • Description: Returns the maximum value from two or more parameters, requiring at least two arguments and returning NULL if any parameter is NULL. Handles mixed data types through implicit numeric conversion where possible.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/200.interval.md

  • Description: Returns the index position where a value falls within specified intervals, handling NULL values by treating them as satisfied conditions. Compares the input value against a list of thresholds to determine its interval placement.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/300.isnull.md

  • Description: Tests whether an expression is NULL, returning 1 for NULL values and 0 for non-NULL values. This function provides a reliable alternative to using the equals sign for NULL comparisons.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/400.least.md

  • Description: Returns the minimum value from two or more parameters, with NULL parameters resulting in a NULL return. Handles mixed numeric and character values through implicit conversion.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/100.case.md

  • Description: Explains the syntax and usage of the CASE conditional expression in SQL, which returns values based on specified conditions or comparisons. Includes declaration formats and practical examples.

• File 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 function, which returns one of two expressions based on whether a condition evaluates to true or false. It covers the function's syntax, behavior with different data types and NULL values, and provides usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/300.ifnull.md

  • Description: Returns expr1 if not NULL, otherwise returns expr2. Determines return type based on expression context and handles case sensitivity when applicable.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/400.nullif.md

  • Description: Returns NULL if two expressions are equal, otherwise returns the first expression. Provides a concise way to handle conditional nullification in SQL queries.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/600.process-control-functions/500.ora-decode.md

  • Description: This function provides Oracle-compatible conditional value matching, evaluating a condition against multiple value pairs and returning corresponding results or a default value. It operates similarly to a series of IF-THEN-ELSE statements for database queries.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/100.approx-count-distinct-agg.md

  • Description: Calculates the approximate number of distinct values for a given expression, useful for determining column selectivity. This function returns a single approximate count rather than exact distinct values.

• File 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, which returns the minimum value from a specified column, supporting both DISTINCT and ALL operations on numeric or string data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1100.std-agg.md

  • Description: Computes the population standard deviation of an expression, returning NULL if no rows match. This function is an alias for STDDEV_POP().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1200.stfdev-agg.md

  • Description: Returns the population standard deviation of a given expression, functioning as an alias for STDDEV_POP(). Returns NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1300.srddev-pop-agg.md

  • Description: Returns the population standard deviation of a given expression, returning NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1400.srddev-samp-agg.md

  • Description: Computes the sample standard deviation of an expression, returning the square root of VAR_SAMP() results. Returns NULL when no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1500.sum-agg.md

  • Description: This document describes the SUM aggregation function, which calculates the total of expression values and returns NULL for empty sets. It supports both regular and distinct value summation with examples provided.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1600.var-pop-agg.md

  • Description: Computes the population variance of a given expression, returning NULL when no matching rows exist.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1700.var-samp-agg.md

  • Description: Calculates the sample variance of an expression, returning NULL for single-value expressions or when no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1800.variance-agg.md

  • Description: Returns the population variance of a given expression, serving as an alias for VAR_POP(). Returns NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/200.avg-agg.md

  • Description: Computes the average value of a specified expression, ignoring null values. Supports optional DISTINCT filtering to calculate the average of unique values only.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/300.bit-and-agg.md

  • Description: Returns the bitwise AND of all bits in an expression, with result type determined by parameter evaluation as binary strings or numbers. Handles NULL values and returns a neutral value when no rows match.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/400.bit-or-agg.md

  • Description: Returns the bitwise OR of all bits in an expression, with result type determined by parameter evaluation as binary strings or numbers. Handles NULL values by ignoring them and returns a neutral value when no rows match.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/500.bit-xor-agg.md

  • Description: Computes the bitwise XOR of all bits in an expression, with result type determined by whether arguments are evaluated as binary strings or numbers. Returns a neutral value (all bits 0) when no matching rows are found or when all values are NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/600.count-agg.md

  • Description: Returns the number of non-NULL values in a column, with options to count distinct values or all rows including NULLs. The function handles empty result sets by returning zero.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/700.group-concat-agg.md

  • Description: Concatenates non-NULL values from a group into a string with optional sorting and custom separators. Supports DISTINCT elimination of duplicates and ORDER BY sorting of values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/800.grouping-agg.md

  • Description: Explains the GROUPING function used to identify super-aggregation rows in SQL queries with GROUP BY and WITH ROLLUP clauses. Provides syntax, examples, and practical applications for distinguishing summary rows from regular grouped data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/900.max-agg-agg.md

  • Description: Returns the maximum value from specified data, supporting both numeric and string parameters with optional DISTINCT or ALL modifiers.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/100.approx-count_distinct.md

  • Description: This function calculates an approximate count of distinct values in an expression, offering significantly faster performance than exact counting methods with negligible deviation for large datasets.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1300.count.md

  • Description: Returns the number of non-NULL values in a result set, with options to count all rows or distinct values. Can be used with analytic clauses for partitioned calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1400.cume-dist.md

  • Description: Calculates the cumulative distribution value of rows within a window partition, returning a ratio between 0 and 1 based on the row's position relative to other rows in the sorted partition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1500.dense-rank.md

  • Description: DENSE_RANK calculates continuous integer rankings for rows based on specified ordering, assigning identical ranks to rows with equal values. The function operates within optional partitions and maintains sequential numbering without gaps between rank values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1600.first_value.md

  • Description: Returns the first value of an expression within a window frame, supporting optional NULLS handling. Includes syntax, description, and practical SQL examples demonstrating usage with partitioned data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/200.avg.md

  • Description: Computes the average value of an expression, ignoring NULL values, with optional distinct value calculation. Supports window functions for analytical operations over partitioned data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2700.lag.md

  • Description: The LAG window function retrieves values from previous rows in a result set based on a specified offset, with options for handling NULL values and partitioning data. It provides an efficient alternative to self-joins for accessing preceding row data in ordered datasets.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2800.last-value.md

  • Description: Returns the last value of an expression within a window frame, supporting optional NULLS handling. This analytic function operates over partitioned data sets as defined in the analytic clause.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2900.lead.md

  • Description: The LEAD window function retrieves data from subsequent rows within a partition, allowing access to values from rows following the current row. It supports optional parameters including offset, default values, and null handling through RESPECT/IGNORE NULLS clauses.

• File 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, which computes the bitwise AND operation across values in an expression. It explains how the function handles different data types and NULL values, and provides usage examples with SQL queries.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3000.max.md

  • Description: Returns the maximum value in specified data, supporting both numeric and string parameters with optional DISTINCT/ALL keywords. Can be used as an analytic function with OVER clause for partitioned calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3100.min.md

  • Description: Returns the minimum value in specified data, supporting both numeric and string parameters with optional DISTINCT/ALL keywords. Includes analytic clause support for window function operations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3200.nth-value.md

  • Description: Returns the nth value of an expression within a window, with options to specify direction and null handling. Supports window functions with an analytic clause for partitioning and ordering.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3300.ntile.md

  • Description: Divides sorted rows into approximately equal-sized groups and assigns group numbers. Returns NULL if the expression is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3400.percent-rank.md

  • Description: Computes the relative rank of each row as a percentage within a specified partition and ordering. This window function returns values between 0 and 1 based on the row's position in the sorted dataset.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3450.percentile_cont.md

  • Description: Calculates the exact percentile of a numeric column using linear interpolation between values. The function ignores NULL values and returns a result consistent with the input column's data type.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3500.rank.md

  • Description: This document explains the RANK window function in SQL, which assigns sequential ranks to rows within partitions while skipping numbers for tied values. It covers the function's syntax, behavior, and provides practical usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3600.row_number.md

  • Description: Assigns a sequential number to each row based on specified ordering, optionally within partitions. This window function organizes result sets with unique row identifiers.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3700.std.md

  • Description: Returns the population standard deviation of an expression, equivalent to STDDEV_POP. Returns NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3800.stddev.md

  • Description: Returns the standard deviation of an expression using the STDDEV_POP calculation. This analytic function returns NULL when no rows match the specified conditions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3900.stddev-pop.md

  • Description: Computes the standard deviation of a given expression, returning NULL when no rows match. Supports analytic operations with an OVER clause for windowing calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/400.bit-or.md

  • Description: This function computes the bitwise OR operation on all values in an expression, handling both binary strings and numeric evaluations. It returns a neutral value when no matching rows are found and ignores NULL values unless all values are NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4000.stddev-samp.md

  • Description: Computes the sample standard deviation of an expression, returning the square root of VAR_SAMP results. Returns NULL when no rows match the query conditions.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4100.sum.md

  • Description: Returns the total of an expression, optionally calculating unique values with DISTINCT, and returns NULL if no rows match. Supports analytic functions for partitioned calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4200.var-pop.md

  • Description: Returns the population variance of an expression, returning NULL if no rows match the query. Supports window function operations with an OVER clause.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4300.var-samp.md

  • Description: Calculates the sample variance of a given expression, returning NULL when no rows are matched. Supports window function operations with an OVER clause.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4400.variance.md

  • Description: Returns the population variance of an expression, serving as an alias for the VAR_POP function. Returns NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/500.bit-xor.md

  • Description: Returns the bitwise XOR of all bits in an expression, with result type determined by binary string or numeric evaluation. Handles NULL values and returns a neutral value when no rows match.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/100.aes-decrypt.md

  • Description: Decrypts ciphertext using the AES algorithm with a specified key and optional initialization vector. Returns the original plaintext from encrypted data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1000.md5.md

  • Description: Computes the 128-bit MD5 checksum of a string, returning the result as a 32-character hexadecimal string. Returns NULL if the input string is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1050.password.md

  • Description: Encrypts a plaintext string and returns the encrypted version. This function takes a single string parameter and outputs the hashed result.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1100.uncompress.md

  • Description: Decompresses strings previously compressed using the COMPRESS() function, restoring them to their original form.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1200.uncompressed-length.md

  • Description: Returns the original length of a string before it was compressed by the COMPRESS() function. This function is used to determine the uncompressed size of compressed data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1300.random-bytes.md

  • Description: Returns a random binary string of specified length between 1 and 1024 bytes.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1400.sha.md

  • Description: Computes the 160-bit SHA-1 checksum of a string, returning it as a 40-character hexadecimal string. This function is equivalent to SHA1().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1500.sha1.md

  • Description: Computes and returns the SHA-1 160-bit checksum for a given string, returning the result as a 40-character hexadecimal string. This function is equivalent to SHA().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1600.sha2.md

  • Description: Computes SHA-2 cryptographic hash values for input strings using specified bit lengths (224, 256, 384, 512). Supports multiple SHA-2 algorithm variants through length parameter selection.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1700.validate-password-strength.md

  • Description: This function evaluates a password string and returns a strength score from 0 (weak) to 100 (strong), with evaluation parameters configurable through system variables.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/1800.sm3.md

  • Description: SM3 is a cryptographic hash function developed by China's National Cryptography Administration, producing a 32-character hexadecimal string output from input data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/200.aes-encrypt.md

  • Description: Encrypts strings using the AES algorithm with configurable key lengths and block encryption modes, supporting optional initialization vectors for enhanced security. Returns encrypted binary data and requires the same parameters for decryption.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/300.compress.md

  • Description: Compresses a string and returns the result as a binary string, with the UNCOMPRESS function available to decompress the output.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/400.decode.md

  • Description: Decrypts an encrypted string using a specified password, returning the original plaintext value.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/500.des-decrypt.md

  • Description: Decrypts strings encrypted with DES_ENCRYPT using either a specified key or keys from the DES key file. Requires SSL support and returns NULL on error or the original string if not encrypted.

• File 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 for encrypting strings using DES encryption with optional key specification. It covers syntax, key file requirements, return value format, and implementation details specific to seekdb's SSL configuration.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/700.encode.md

  • Description: Encrypts a string using a password, producing a binary result of equal length. Requires the DECODE function for decryption.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/800.encrypt.md

  • Description: Encrypts a string using the Unix crypt() system call, optionally using a specified salt parameter. Returns a binary string or NULL if the system doesn't support crypt() or if an invalid salt is provided.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/100.benchmark.md

  • Description: Executes a scalar expression repeatedly to measure client-side performance, returning 0 upon completion or NULL for invalid arguments.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1000.icu-version.md

  • Description: This function returns the version of the ICU library used for regular expression operations, which provides complete Unicode support and multibyte character safety.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1050.ob_transaction_id.md

  • Description: Returns the active transaction ID for the current session if in a transaction, otherwise returns 0.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1100.row-count.md

  • Description: Returns the number of rows affected by the executed SQL statement, with different return values for DDL, DML, and SELECT statements.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1200.schema.md

  • Description: Returns the name of the current schema, serving as a synonym for the DATABASE() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1300.session-user.md

  • Description: Returns the current username and hostname in utf8mb4 format, serving as a synonym for the USER() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1400.system-user.md

  • Description: Returns the current username and hostname, serving as a synonym for the USER() function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1500.user.md

  • Description: Returns the username and hostname of the current MySQL user as a utf8mb4 string.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1600.version.md

  • Description: Returns the version number of the current MySQL-compatible seekdb instance. The output is provided in the utf8mb4 character set.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/200.charset.md

  • Description: Returns the character set of a given string. Includes examples demonstrating usage with both standard and binary-converted strings.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/300.coercibility.md

  • Description: Returns the collation priority value of a string expression, which determines precedence when comparing values with different character sets or collations. The function helps resolve collation conflicts by assigning priority levels from 0 (explicit) to 6 (ignorable).

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/400.collation-info.md

  • Description: This document describes the COLLATION function, which returns the collation of a specified string. It includes syntax examples and references supported collations in seekdb.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/500.connection-id.md

  • Description: Returns the unique client session ID for the current database connection. This function identifies the specific session on the client.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/550.current-role.md

  • Description: Returns the currently active role(s) for the user in the session, indicating which permissions are available. Shows NONE if no role is activated.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/600.current-user.md

  • Description: Describes the CURRENT_USER() function, which returns the login account name as a combination of username and hostname in utf8mb4 character set.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/700.database.md

  • Description: Returns the name of the current database in utf8mb4 character set; returns NULL if no database is selected.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/800.found-rows.md

  • Description: Returns the number of rows a SELECT statement would have returned without its LIMIT clause when used with the SQL_CALC_FOUND_ROWS option.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/900.last-insert-id.md

  • Description: Returns the auto-increment value for the last inserted row in the current session, specifically providing the value from the first row when multiple rows were inserted.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/910.last-insert-id-behavior-description.md

  • Description: Describes the behavior of the LAST_INSERT_ID() function in seekdb, highlighting its compatibility with MySQL and key differences in handling AUTO_INCREMENT columns during INSERT operations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/100.create-json-text-function/100.json-array.md

  • Description: Returns a JSON array containing the input values, which can include various data types or be empty.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/100.create-json-text-function/200.json-object.md

  • Description: Returns a JSON object from provided key-value pairs, requiring an even number of parameters to avoid errors.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/100.create-json-text-function/300.json-quote.md

  • Description: Converts a string into a valid JSON string literal by adding double quotes and escaping internal characters. Returns NULL if the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/100.json-contains.md

  • Description: Checks whether a specified JSON document is contained within a target JSON document, or if a specific element exists at a given path. Returns 1 if contained and 0 otherwise.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/200.json-contains-path.md

  • Description: Checks whether specified paths exist in a JSON document, returning 1 if paths are found and 0 otherwise based on 'one' or 'all' mode selection.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/300.json-extract.md

  • Description: Extracts data from specified paths in JSON documents, returning NULL for invalid paths or parameters. Returns single values or arrays of matching values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/400.json-keys.md

  • Description: Extracts top-level keys from a JSON object at a specified path, returning them as an array. Returns NULL for invalid inputs or non-object values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/500.json-overlaps.md

  • Description: Compares two JSON documents and returns 1 if they share any key-value pairs or array elements, otherwise returns 0. Supports scalar comparisons and can be optimized with multi-value indexes on InnoDB tables.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/600.json-search.md

  • Description: Returns the path to a specified string within a JSON document, supporting pattern matching with wildcards and options to find either the first match or all matches.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/700.json-value.md

  • Description: Extracts a value from a JSON document at a specified path, with optional type conversion and error handling clauses. Supports various return types including numeric, date, and character data types.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/200.search-json-text-function/800.member-of.md

  • Description: Tests whether a value is present in a JSON array, returning 1 if found and 0 otherwise. Works with both scalar values and JSON documents.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/100.json-array-append.md

  • Description: Appends a specified value to the end of a specified array in a JSON document, returning the result. It can handle multiple path-value pairs and automatically wraps non-array values in arrays before appending.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/1000.json-unquote.md

  • Description: Unquotes a JSON value and returns the result as a utf8mb4 string. Returns NULL if the input is NULL and raises an error for invalid JSON string literals.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/120.json-append.md

  • Description: Appends a specified value to the end of a specified array in a JSON document and returns the result. It is an alias for the JSON_ARRAY_APPEND function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/200.json-array-insert.md

  • Description: Inserts values into specified positions within a JSON array, shifting existing elements as needed. Handles multiple path-value pairs and validates input parameters.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/300.json-insert.md

  • Description: Inserts specified values into a JSON document at given paths without overwriting existing values. Returns the modified JSON document or NULL if parameters are invalid.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/400.json-merge.md

  • Description: Merges multiple JSON documents into a single combined JSON document, equivalent to JSON_MERGE_PRESERVE().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/500.json-merge-patch.md

  • Description: Merges multiple JSON documents according to RFC 7396, handling duplicate keys and null values while returning the combined result.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/600.json-merge-preserve.md

  • Description: Merges multiple JSON documents by combining arrays, objects, and scalar values while preserving all data elements. Returns NULL if any input is NULL and raises an error for invalid JSON inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/700.json-remove.md

  • Description: Removes specified data from a JSON document and returns the result, handling invalid paths by leaving the document unchanged.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/800.json-replace.md

  • Description: Replaces existing values in a JSON document and returns the result, ignoring non-existent paths while overwriting existing values. Requires valid JSON input and path expressions without wildcards.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/300.modify-json-text-function/900.json-set.md

  • Description: Inserts or updates values in a JSON document at specified paths, returning the modified document. Handles both existing and new elements while maintaining valid JSON structure.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/100.json-depth.md

  • Description: Returns the maximum depth of a JSON document, handling various structures including arrays, objects, and scalar values. Returns NULL for null inputs and errors for invalid JSON documents.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/200.json-length.md

  • Description: Returns the length of a JSON document or the value at a specified path, with length defined as 1 for scalars and the count of elements or members for arrays and objects.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/300.json-type.md

  • Description: Returns the JSON value type as a utf8mb4 string, handling objects, arrays, and scalars while returning NULL for null inputs and errors for invalid JSON.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/400.return-json-text-property-function/400.json-valid.md

  • Description: Tests whether an input value is valid JSON, returning 1 for valid JSON and 0 for invalid JSON. Handles NULL inputs by returning NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/450.json-table-functions.md

  • Description: The JSON_TABLE function converts JSON data into relational tables by extracting values through specified paths, enabling structured querying and data manipulation. It supports column definitions for ordinality, value extraction, existence checks, and nested structures.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/500.json-utility-function/100.json-pretty.md

  • Description: Formats JSON values with human-readable indentation and line breaks. Handles arrays, objects, and scalar values while maintaining proper JSON structure and escaping rules.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/500.json-utility-function/200.json-storage-size.md

  • Description: Calculates the binary storage size in bytes for JSON documents, accepting either JSON values or parseable strings. Returns NULL for null inputs and errors for invalid JSON.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/600.json-aggregate-function/100.json-arrayagg.md

  • Description: Aggregates result sets into JSON arrays with undefined element ordering. Returns NULL if no rows are returned or an error occurs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/600.json-aggregate-function/200.json-objectagg.md

  • Description: This function aggregates key-value pairs into a JSON object, retaining the last value for duplicate keys. It returns NULL if no rows are processed or if errors occur with NULL keys or incorrect parameter counts.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/700.json-functions/700.json-schema-function/100.json-schema-valid.md

  • Description: Validates JSON documents against JSON Schema specifications, returning 1 for valid documents and 0 for invalid ones. Supports schema attributes like required, type, and description while enforcing proper JSON formatting for both schema and document parameters.

• File 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 function validates a JSON document against a JSON schema and returns a detailed report indicating whether the document is valid or providing specific failure details if invalid.

• File 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 JSON functions supported by seekdb, including functions for creating, modifying, searching, and validating JSON documents. It covers operations such as array manipulation, data extraction, and schema validation.

• File 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 from XML nodes and UPDATEXML for modifying XML content.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/750.xml-functions/300.querying-xmltype-data-functions/100.extractvalue-function.md

  • Description: Extracts values from XML strings using XPath expressions, returning results as LONGTEXT. The function handles multiple values by concatenating them with spaces and returns empty strings when no matches are found.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/750.xml-functions/400.modify-xmltype-data-functions/100.updatexml-function.md

  • Description: Updates XML content by replacing nodes specified with an XPath expression. Returns the modified XML string as LONGTEXT.

• File 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 spatial functions in seekdb for processing geographic data, covering geometry creation, spatial operations, analysis, and format conversions. It enables complex spatial queries and GIS applications at the database level.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/1000.spatial-processing-function.md

  • Description: This document covers spatial geometry processing functions, specifically detailing the _ST_MakeValid function which repairs invalid geometries in projected coordinate systems. It includes syntax, parameter descriptions, and usage examples for this geometry validation tool.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/1100.spatial-geohash-function.md

  • Description: Converts geometry objects into GeoHash string representations, with optional precision control for varying levels of geographical accuracy. Supports points and polygons by encoding locations into compact alphanumeric strings that represent approximate geographical areas.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/150.create-a-geometry-function.md

  • Description: This document explains how to create geometry values in various formats using functions like ST_GeomFromText, ST_GeomFromWKB, and _ST_MakePoint, including their syntax, parameters, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/200.spatial-operation-functions.md

  • Description: This document covers spatial operation functions in seekdb for generating geometry, including ST_Buffer, ST_Transform, ST_Difference, ST_Union, ST_SymDifference, and _ST_ClipByBox2D, with details on their syntax, parameters, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/300.spatial-relation-functions.md

  • Description: This document details spatial relationship functions in seekdb, including ST_Intersects, ST_Contains, ST_Distance, and others that test geometric relationships between two values. It provides syntax, usage examples, and specific behavior for each function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/400.geometry-attribute-functions.md

  • Description: This documentation covers geometry attribute functions in seekdb for accessing spatial object attributes, including ST_Area, ST_SRID, ST_Latitude, ST_Longitude, ST_X, and ST_Y functions. It provides syntax, usage examples, and error handling for calculating areas, retrieving coordinates, and managing spatial reference systems.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/500.geometry-conversion-function.md

  • Description: This document covers geometry conversion functions that transform internal geometry formats into WKT or WKB representations, including ST_AsBinary, ST_AsWKB, ST_AsText, and ST_AsWKT. It explains their syntax, coordinate order handling, and important implementation considerations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/600.spatial-analysis-function.md

  • Description: This document covers spatial analysis functions in seekdb, including ST_Length for calculating geometry lengths with unit conversion, ST_Centroid for finding geometric centers, and _ST_PointOnSurface for identifying points on geometry surfaces.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/700.spatial-constructor-function.md

  • Description: This document covers spatial construction functions in seekdb, specifically detailing the _ST_MakeEnvelope function for creating rectangular bounding boxes from coordinate pairs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/800.spatial-accessor-function.md

  • Description: This document describes spatial accessor functions in seekdb, including _ST_GeometryType, _ST_IsCollection, and _ST_NumInteriorRings, which extract components and properties from spatial geometry objects.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/900.spatial-format-conversion-function.md

  • Description: This document covers spatial format conversion functions for converting geometry objects between different data representations, including ST_AsGeoJSON for GeoJSON output, _ST_AsMVT for Mapbox vector tiles, and ST_AsMVTGeom for MVT coordinate system conversion.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/900.performance-schema/100.format-bytes.md

  • Description: Converts a numeric byte count into a human-readable string with appropriate units (bytes, KiB, MiB, etc.), rounding to two decimal places for values above 1023 bytes. Returns NULL if the input is NULL.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/900.performance-schema/200.format-pico-time.md

  • Description: Converts picosecond values into human-readable time units with appropriate labels, ranging from picoseconds to days. Returns NULL for NULL inputs and formats values with two decimal places and at least three significant digits.

• File 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 management functions, including acquiring, checking, and releasing named locks.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/200.get-lock.md

  • Description: Acquires a named lock with a specified timeout, returning success, failure, or error status. Locks are session-specific and must be explicitly released or are automatically released upon session termination.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/300.is-free-lock.md

  • Description: Checks whether a named lock is currently free or held by any session, returning 1 if available and 0 if in use.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/400.is-used-lock.md

  • Description: Checks whether a named lock is currently in use by any session, returning the session ID if acquired or NULL if not.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/500.release-all-locks.md

  • Description: Releases all named locks held by the current session and returns the count of successfully released locks.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/600.release-lock.md

  • Description: Releases a named lock obtained by the current session using GET_LOCK(), returning 1 on success, 0 if not held, or NULL if the lock does not exist.

• File 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 seekdb's bitmap functions for efficiently handling compressed bitmap data, including constructor, cardinality, operation, decision, output, and aggregate functions. It covers their applications in user behavior analysis, profiling, and audience targeting.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/200.roaring-bitmap-constructor-functions.md

  • Description: This document covers RoaringBitmap constructor functions including rb_build, rb_build_empty, rb_build_varbinary, and rb_from_string for creating RoaringBitmap data from arrays, empty sets, binary strings, and comma-separated strings respectively. It also includes the rb_select function for filtering and selecting subsets from existing RoaringBitmaps.

• File 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 bitmap cardinality calculation functions, including operations for individual bitmaps, pairwise logical operations, and aggregate functions for union/intersection cardinalities.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/400.roaring-bitmap-operation-functions.md

  • Description: This document describes bitmap operation functions for performing logical operations on bitmap data, including intersection, union, XOR, and difference operations. It covers standard functions and their null-handling variants for robust data processing.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/500.roaring-bitmap-decision-functions.md

  • Description: This document describes two bitmap decision functions in seekdb: rb_is_empty() for checking if a bitmap is empty, and rb_contains() for determining if one bitmap contains another or if a bitmap contains a specific offset.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/600.roaring-bitmap-output-functions.md

  • Description: This document covers bitmap output functions in seekdb, including rb_to_varbinary, rb_to_string, rb_iterate, and rb_to_array for converting bitmap data into various formats such as binary, string, array, and expanded table rows.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/940.roaring-bitmap-functions/700.roaring-bitmap-aggregate-functions.md

  • Description: This document describes three bitmap aggregate functions in seekdb: rb_build_agg for building bitmaps from numeric data, rb_or_agg for combining bitmaps with OR operations, and rb_and_agg for combining bitmaps with AND operations. It covers their syntax, parameters, and provides usage examples.

• File 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 the seekdb system, covering functions for constructing, analyzing, manipulating, and outputting array data types. It includes detailed descriptions of specific functions for array operations like aggregation, filtering, sorting, and mathematical calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/200.array-constructor-functions.md

  • Description: This document covers array constructor functions in seekdb, including the array() function, rb_build() for RoaringBitmap conversion, and the [] operator for creating arrays.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/300.array-decision-functions.md

  • Description: This document describes array decision functions in seekdb, including array_contains(), array_contains_all(), array_overlaps(), and the ANY() operator, which perform Boolean checks on array elements.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/500.array-output-functions.md

  • Description: Converts array elements into a string with specified delimiters and optional null element symbols, supporting both flat and nested arrays.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/600.array-manipulation-functions.md

  • Description: This document describes array manipulation functions in seekdb, including operations for modifying, searching, and transforming arrays such as appending elements, removing duplicates, and converting strings to arrays.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/960.text-processing-functions/200.tokenize.md

  • Description: This function tokenizes text using specified parsers and JSON parameters, supporting multiple languages and output formats including token lists or frequency counts.

• File 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 map functions in seekdb, covering constructor, decision, and manipulation functions for processing and analyzing map data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/200.map-constructor-functions.md

  • Description: This document covers the map constructor functions and operators in seekdb, including the map() function and operator for creating map data types with unique key-value pairs.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/300.map-decision-functions.md

  • Description: Map decision functions perform equality and inequality comparisons on map data, returning Boolean results. These operators evaluate whether two maps have identical keys and values.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/980.map-functions/600.map-manipulation-functions.md

  • Description: This document covers mapping operation functions in seekdb, specifically explaining how to use the map_keys() and map_values() functions to extract keys and values from mapping data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/990.sequence-function/100.nextval.md

  • Description: This function retrieves the next value from a specified sequence and increments it, commonly used for generating unique identifiers in database operations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/990.sequence-function/200.currval.md

  • Description: This document explains the CURRVAL(SEQ) function, which retrieves the current value of a MySQL sequence, and provides examples of its usage alongside NEXTVAL.

• File 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, covering basic operations like selection, projection, and join, along with essential query components including FROM, WHERE, ORDER BY, GROUP BY, LIMIT, and HAVING clauses.

• File Path: 450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/200.subquery-of-syntax.md

  • Description: This document explains SQL subqueries, covering their types, syntax, and usage in clauses like SELECT, FROM, and WHERE. It includes details on scalar, row, correlated, and derived subqueries, along with optimization techniques like unnesting.

• File Path: 450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/300.connection.md

  • Description: This document explains database connection operations for combining tables, covering inner, outer, semi, and anti joins along with their syntax and implementation details. It includes practical examples and discusses connection conditions and self-joins.

• File Path: 450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/400.full-text-query.md

  • Description: This document explains how to perform full-text queries using the MATCH AGAINST syntax, covering both natural language and boolean search modes, and includes examples for creating indexes and executing searches.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/100.general-syntax.md

  • Description: This document covers the general syntax of SQL statements, including constants, character sets, data types, SQL attributes, and storage attributes. It provides detailed specifications for each component with syntax examples and value definitions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1100.alter-compile.md

  • Description: This statement recompiles stored procedures or functions, requiring ALTER privilege to execute. It supports optional reuse of original compilation settings or current session parameters.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1200.alter-database.md

  • Description: This statement modifies database properties including character sets, collations, and read/write permissions. It applies to either a specified database or the current database when none is named.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1220.alter-external-table.md

  • Description: Updates external table files when data comes from multiple sources, requiring manual refresh to reflect changes. Syntax and usage examples are provided.

• File 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 statement syntax and parameters for modifying materialized view properties, including refresh parallelism, refresh strategies, and scheduling options.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1251.alter-materialized-view-log-in-sql.md

  • Description: This document details the ALTER MATERIALIZED VIEW LOG statement syntax and parameters for modifying materialized view log attributes, including parallelism, purge intervals, and LOB storage thresholds. It covers required privileges and provides practical usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1300.alter-outline.md

  • Description: This statement adds throttling rules and binds outlines to modify existing SQL_TEXT outlines. It supports specifying execution plans or concurrency controls through hint-based DML statements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1400.alter-sequence.md

  • Description: Modifies an existing sequence's properties including increment, range, caching, and cycling behavior. Changes apply only to future sequence values and require appropriate user privileges.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1600.alter-table.md

  • Description: This document describes the ALTER TABLE statement for modifying table structures, including adding, modifying, or dropping columns, constraints, indexes, and partitions. It provides syntax details and parameter descriptions for each supported operation.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1800.alter-user.md

  • Description: This document describes the ALTER USER statement for modifying user accounts, including changing passwords, locking/unlocking users, setting default roles, and adjusting resource options. It provides syntax, parameter descriptions, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1900.alter-view.md

  • Description: This document describes the ALTER VIEW statement for modifying view definitions, including required privileges, syntax parameters, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/200.universal-table-expression.md

  • Description: This document explains common table expressions (CTEs) in seekdb, covering both non-recursive and recursive types. It details CTE syntax, usage scenarios, and provides practical examples for query optimization and hierarchical data handling.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2000.analyze.md

  • Description: This statement collects statistics for tables or partitions, supporting both precise computation and estimation methods with configurable histogram buckets and sampling options.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2040.cache-index.md

  • Description: This statement loads database table indexes into the cache to improve query performance, though the current version only supports the syntax without functional implementation.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2050.create-concurrent_limiting_rule.md

  • Description: Creates a throttling rule to limit concurrency for specific SQL statements by defining scope, user, SQL type, optional keywords, and maximum concurrency.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2100.create-database.md

  • Description: This document explains how to create a database using the CREATE DATABASE statement, including syntax, required privileges, and configurable properties like character set, collation, and read/write attributes.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2150.create-external-catalog.md

  • Description: Creates an external catalog to connect to ODPS data sources, enabling direct querying of external data without importing it.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2200.create-external-table.md

  • Description: Creates an external table for reading data from external storage services like OSS, S3, or local files, supporting formats such as CSV, Parquet, ORC, and ODPS. The table is read-only and requires defining file paths, formats, and optional parameters like partitioning and auto-refresh settings.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2220.create-index.md

  • Description: This document explains how to create indexes in seekdb to improve query performance, covering syntax, parameters, index types, and limitations. It includes details on unique, full-text, and spatial indexes, along with tokenizer options and storage clauses.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2250.create-materialized-views-in-sql.md

  • Description: This document explains how to create materialized views in SQL, covering syntax, parameters, refresh options, and storage formats. It includes practical examples and references for managing materialized views effectively.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2251.create-materialized-views-log-in-sql.md

  • Description: This document explains how to create materialized view logs (MLOGs) in SQL to track incremental changes in base tables for fast materialized view refreshes. It covers syntax, parameters, privilege requirements, and includes practical examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2300.create-outline.md

  • Description: This document explains how to create outlines using either SQL_TEXT or SQL_ID, detailing the syntax, parameters, and priority rules for binding execution plans to specific SQL statements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2350.create-format-outline.md

  • Description: This document explains how to create fuzzy outlines using either FORMAT_SQL_TEXT or FORMAT_SQL_ID, detailing syntax, parameters, and considerations for binding SQL execution plans.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2450.create-role.md

  • Description: This document explains how to create roles for permission management using the CREATE ROLE statement, including required privileges, syntax, and examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2500.create-sequence.md

  • Description: Creates a database sequence object that generates unique integer values, with configurable parameters for starting value, increment, range, caching, and cycling behavior.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2600.create-table.md

  • Description: This document provides the syntax and parameters for creating tables in a database, including options for temporary tables, constraints, indexes, partitioning, and storage settings. It covers both basic table creation and advanced features like generated columns and full-text indexing.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2800.create-user-of-syntax.md

  • Description: This document describes the CREATE USER statement for creating new database users, including syntax options for authentication methods, TLS requirements, and resource limitations. It also covers required privileges and provides usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2900.create-view.md

  • Description: This document explains how to create views using the CREATE VIEW statement, covering syntax, parameters, permissions, and limitations including considerations for updatable join views and check options.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2960.create-event.md

  • Description: Creates and schedules database events to execute SQL statements at specified times or intervals, supporting stored procedures and flexible timing configurations.

• File 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_action statement for initiating major and minor compactions at system, instance, and partition levels, including syntax, parameters, considerations, and examples.

• File 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 LOAD MODULE DATA and ALTER SYSTEM CHECK MODULE DATA statements for importing and verifying module features, with current version support limited to the REDIS module. It covers syntax, parameters, usage examples, and required ALTER SYSTEM privileges.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/2200.flush-plan-cache.md

  • Description: Clears cached execution plans for specified databases and SQL statements, with options to target specific queries or apply globally across nodes.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/2600.parameter.md

  • Description: This document explains how to modify and reset system parameters using the ALTER SYSTEM SET and ALTER SYSTEM RESET statements, including syntax, permissions, and effectiveness considerations.

• File 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, which clears the dynamic memory KVCache. It includes syntax, parameter details, and an example usage.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/4100.throttle.md

  • Description: This document describes the SQL THROTTLE statement for controlling database requests by enabling or disabling throttling based on performance metrics like response time and queue wait time for specific priority sessions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/4600.wash-memory-fragmentation.md

  • Description: This document describes how to automatically or manually clear memory fragmentation using the ALTER SYSTEM WASH MEMORY FRAGMENTATION statement, including its syntax, parameters, and privilege requirements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3000.deallocate-prepare.md

  • Description: This document explains the DEALLOCATE PREPARE statement, which removes a previously prepared SQL statement from memory. It covers syntax, parameters, and provides usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3200.delete.md

  • Description: This document provides the syntax, parameters, and examples for using the DELETE statement to remove rows from single or multiple tables, including privilege requirements and limitations.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3300.describe.md

  • Description: Retrieves schema information for tables or columns using DESCRIBE, EXPLAIN, or DESC commands. Includes syntax examples for viewing table structures and specific column definitions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3350.drop-catalog.md

  • Description: This document describes the DROP CATALOG statement for removing external data catalogs, including required privileges, syntax parameters, and usage examples.

• File 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 statement, which removes specified concurrent limiting rules and immediately invalidates them while allowing queued SQL statements to execute. It covers required privileges, syntax, and provides usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3400.drop-database.md

  • Description: This document describes the DROP DATABASE SQL statement, which deletes databases and includes the optional IF EXISTS clause to prevent errors when removing non-existent databases.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3500.drop-index.md

  • Description: This document describes the DROP INDEX statement, including its syntax, parameters, and usage examples for removing indexes from database tables.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3550.drop-materialized-views-in-sql.md

  • Description: This document explains how to drop materialized views in SQL, covering syntax, parameters, and required privileges. It includes practical examples and optional behaviors like CASCADE and RESTRICT.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3551.drop-materialized-views-log-in-sql.md

  • Description: Drops a materialized view log from a specified base table, requiring DROP TABLE privileges and potentially blocking during active transactions. The document covers syntax, parameters, and usage examples for this operation.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3600.drop-outline.md

  • Description: This document describes the DROP OUTLINE statement used to remove an outline in seekdb, including its syntax, parameters, and an example.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3660.drop-role.md

  • Description: This document describes the DROP ROLE statement for removing database roles, covering syntax, required privileges, and operational limitations including automatic revocation from users and mandatory role restrictions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3700.drop-table.md

  • Description: This document describes the DROP TABLE statement syntax for deleting tables in seekdb, including parameters like IF EXISTS and TEMPORARY, with usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3900.drop-sequence.md

  • Description: This document describes the DROP SEQUENCE SQL statement, covering its syntax, parameters, and usage for removing database sequences.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/4000.drop-user.md

  • Description: This document describes the DROP USER statement for removing database users, including required privileges, syntax parameters, and behavior when deleting non-existent users. It also covers the automatic revocation of all user privileges upon deletion.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/4100.drop-view.md

  • Description: This document describes the DROP VIEW statement syntax and usage for removing one or more views, including optional parameters like IF EXISTS and CASCADE/RESTRICT, along with permission requirements and examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5200.execute.md

  • Description: Executes a prepared SQL statement with optional variable parameters, allowing for dynamic query execution with user-defined inputs.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5300.explain.md

  • Description: This document explains the EXPLAIN statement, which analyzes execution plans for SQL operations like SELECT, DELETE, INSERT, REPLACE, or UPDATE. It details syntax, parameters for output customization, and provides examples of saving and displaying plan information.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5400.flashback-database.md

  • Description: Restores deleted databases and tables from the recycle bin, including dependent objects like indexes. Includes syntax for renaming objects during recovery and managing recycle bin settings.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5420.fork-table-in-sql.md

  • Description: Creates a destination table from a consistent snapshot of a source table, providing independent read/write capabilities while avoiding full data copies through storage structure reuse. This experimental feature offers snapshot consistency and isolation but has limitations including unsupported table types and indexes.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5450.flush-table.md

  • Description: This document describes the syntax and usage of the FLUSH TABLE statement, which is currently supported but non-functional without enabling a specific hidden configuration parameter. It covers the statement's purpose for clearing internal caches and tables, along with required activation steps.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5500.grant.md

  • Description: This document describes the GRANT statement for assigning permissions to users or roles and delegating roles in seekdb. It covers syntax, privilege requirements, limitations, and usage examples for both object privileges and role assignments.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5600.help.md

  • Description: This document describes the HELP command, which retrieves search results from the help table using wildcard-enabled search strings to find categories, topics, or specific keywords.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5700.insert-sql.md

  • Description: This document details the INSERT statement syntax for adding records to database tables, covering parameters, permissions, limitations, and examples of various insertion methods including direct values, SELECT queries, and overwrite operations.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5800.kill.md

  • Description: This document describes the KILL statement for terminating sessions or queries, including required privileges, syntax parameters, and usage examples. It covers session identification through SHOW PROCESSLIST and different termination options.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5900.load-data-of-syntax.md

  • Description: This document describes the LOAD DATA statement for importing data from server-side files, client-side files, and OSS into database tables, covering syntax, parameters, and considerations. It supports CSV files and includes details on direct load options and partitioning.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5950.load-index-into-cache.md

  • Description: This statement loads one or more indexes into the cache to improve query performance by reducing system overhead during index loading. Note that while supported, this functionality is not yet effective in the current version.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/6000.lock-table.md

  • Description: This document describes the LOCK TABLES statement for preventing concurrent operations on database tables, covering syntax, privileges, limitations, and usage examples. It explains how to acquire and release table locks to control DML and DDL operations during sessions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7000.optimize.md

  • Description: This statement initiates a progressive major compaction on specified tables, with the number of compactions determined by each table's progressive_merge_num parameter.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7100.prepare.md

  • Description: This document describes the PREPARE statement for creating named SQL statements that can be executed later within a session, including syntax, parameters, supported SQL commands, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7200.purge-database.md

  • Description: This statement permanently deletes database objects from the recycle bin, including databases, tables, and indexes, using their system-generated recycle bin names.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7300.purge-recyclebin.md

  • Description: This statement empties the recycle bin by permanently deleting all database objects within it. Only the root user can execute this command.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7400.rename-user.md

  • Description: Modifies the username of a login user in seekdb, requiring the global CREATE USER privilege. The command supports renaming single or multiple users while preserving their existing permissions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7500.rename-table.md

  • Description: This statement renames one or more tables, including moving tables between databases. The operation requires specific privileges and locks tables during execution, with considerations for transaction activity and performance impacts.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7600.replace.md

  • Description: This document describes the REPLACE SQL statement, which inserts new records into a table or replaces existing records when primary or unique key conflicts occur. It covers syntax, parameters, and provides usage examples for this conditional insert/replace operation.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7650.repalr-table.md

  • Description: This statement repairs potentially damaged tables, though the feature is currently unavailable and only the syntax is supported in this version.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7700.revoke.md

  • Description: This document describes the REVOKE statement for removing privileges from users or roles and revoking roles from users or roles. It covers syntax, parameters, limitations, and privilege requirements for executing revocation commands.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7800.savepoint.md

  • Description: This document explains how to create and use savepoints within transactions, enabling partial rollbacks. It covers the syntax for creating, rolling back to, and releasing savepoints, along with the internal rollback process.

• File 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 and provides references to related SQL statements for creating, altering, and dropping databases.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8000.select-into.md

  • Description: This document describes the SELECT INTO statement for storing query results in variables or external files, including syntax, parameters, and privilege requirements for various output formats and destinations.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/100.select.md

  • Description: This document provides the syntax and usage guidelines for the SELECT statement, covering data querying from tables, required permissions, and detailed parameter descriptions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/200.join-clause.md

  • Description: This document describes the JOIN clause syntax for combining rows from multiple tables, including inner, outer, and cross joins, along with required permissions and parameter details.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/300.over-clause.md

  • Description: Defines named windows with specific specifications for analytic functions in SELECT queries, supporting both ROWS and RANGE frame semantics. Includes syntax, parameters, and examples for partitioning, ordering, and window boundary definitions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/400.union-clause.md

  • Description: This document describes the UNION clause and other set operations (UNION ALL, MINUS, EXCEPT, INTERSECT) for combining results from multiple SELECT queries, including syntax, parameters, limitations, and examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.set-default-role.md

  • Description: This statement sets default roles for users upon login, including options to activate all roles, specific roles, or no roles. It covers syntax, parameters, privileges required, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8200.set.md

  • Description: This statement sets session-level or global variables, including user and system variables, with options for direct assignment or values derived from SELECT queries.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8250.set-catalog.md

  • Description: This statement switches between internal and external data catalogs in seekdb, requiring the USE CATALOG privilege to execute. It enables users to change their active catalog context for database operations.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8300.set-charset.md

  • Description: Sets the client and results character set, supporting values like utf8, utf8mb4, gbk, utf16, and gb18030, or the system default.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8400.set-names.md

  • Description: Sets the client, connection, and result character sets and collations, supporting various character encodings and collation options.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8500.set-password.md

  • Description: This statement changes the password for the currently logged-in user or another specified user in seekdb, requiring appropriate privileges when modifying other users' passwords.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8550.set-role.md

  • Description: This document explains the SET ROLE SQL statement, which activates specific roles for the current user session. It covers syntax options including DEFAULT, NONE, ALL, and role-specific parameters with usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8600.set-transaction.md

  • Description: This document describes the SET TRANSACTION command for configuring transaction isolation levels and access modes in seekdb, including syntax, parameters, and usage constraints. It covers supported isolation levels (Read Committed and Repeatable Read) and scope options (GLOBAL, SESSION, LOCAL).

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8700.show.md

  • Description: This document describes the SHOW statement syntax and usage for displaying information about database objects such as tables, schemas, indexes, and system status in a database system.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8750.submit-job.md

  • Description: This statement creates asynchronous tasks for large-scale data import operations, supporting SQL statements like INSERT SELECT and LOAD DATA INFILE to prevent failures with substantial data volumes.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8760.show-job-status.md

  • Description: This command queries the status of asynchronous tasks, allowing users to view all their own jobs or filter by job ID. The root user can see all jobs, while regular users can only view their own.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8770.cancel-job.md

  • Description: Cancels an asynchronous task by job_id, terminating running jobs and preventing queued jobs from executing, while allowing users to view canceled job status.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8800.transaction.md

  • Description: This document explains how to use SQL transaction statements to start, commit, and roll back database transactions, ensuring data integrity through atomic operations. It covers syntax, parameters, and provides practical examples for transaction management.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8900.truncate-table.md

  • Description: This document describes the TRUNCATE TABLE statement, which efficiently empties a table while preserving its structure and partition information. It covers syntax, performance benefits over DELETE, limitations, and privilege requirements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8950.unlock-tables.md

  • Description: This document describes the UNLOCK TABLES statement, which releases all table locks held by the current session without committing transactions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/9000.update.md

  • Description: This document provides the syntax, parameters, and usage examples for the UPDATE statement, including its limitations, required privileges, and practical applications for modifying table data.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/9100.use.md

  • Description: Switches the current session to a specified database, allowing subsequent operations to be performed within that database context.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/9200.value.md

  • Description: This document explains the VALUES statement, a table-value constructor that returns sets of data rows. It covers syntax, parameters, and usage examples including sorting and combining with set operations like UNION.

• File 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 features in seekdb, including operations for indexes, keys, columns, tables, and partitions.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/150.online-and-offline-ddl-list.md

  • Description: This document outlines the differences between online and offline DDL operations in seekdb, including their definitions, advantages, and characteristics. It also provides detailed tables listing supported operations and a method to determine whether a DDL operation is online or offline.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/200.index-operations.md

  • Description: This document details how to create, view, add, delete, and rename indexes in seekdb, including syntax examples and parameter descriptions for each operation.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/300.primary-key-operations.md

  • Description: This document provides syntax and examples for adding, modifying, and dropping primary keys in seekdb using ALTER TABLE commands. It includes practical code snippets and references for further details.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/400.column-operations.md

  • Description: This documentation covers column operations in seekdb, including adding, dropping, renaming, reordering, and modifying columns, with syntax examples and use cases.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/500.generated-column-operations.md

  • Description: Covers operations for generated columns in seekdb, including adding, modifying, and dropping both STORED and VIRTUAL column types.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/600.foreign-key-operations.md

  • Description: This document covers how to add and drop foreign key constraints in seekdb, providing the syntax and examples for both operations.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/700.table-operations.md

  • Description: This document covers how to modify table properties in seekdb, including row format, block size, character set, and table renaming operations using ALTER TABLE syntax.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/800.partitioning-operations.md

  • Description: This document covers partitioning operations in seekdb, including repartitioning, adding, dropping, and truncating partitions with corresponding SQL syntax and examples.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/900.column-type-change-rule.md

  • Description: This document outlines column type change rules in seekdb, covering table-level constraints and conversion rules between numeric, character, and time data types. It details supported and restricted scenarios for both Online and Offline DDL operations.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/950.number-type-change-rule.md

  • Description: This document outlines the storage formats and conversion rules for NUMBER data types in seekdb, covering fixed-point, unsigned fixed-point, and floating-point numbers. It specifies compatibility conditions and constraints for type conversions between different numeric formats.

• File 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 cannot be modified. It covers the specific pseudo columns supported in the current version, including PARTITIONID and Sequence.

• File 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 and related pseudo columns that provide partition identification metadata for database rows, including their syntax, usage limitations, and configuration options.

• File 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) to retrieve current and next values from database sequences, including usage scenarios and limitations.

• File Path: 450.reference/200.sql/90.sql-overview.md

  • Description: This document provides an overview of SQL, covering its history, standards, functionality, and portability as the standard language for relational database management systems. It explains SQL's core components and conventions for usage.

Pl

• File Path: 450.reference/300.pl/100.basic-syntax.md

  • Description: This document covers the syntax of PL stored programs, including BEGIN...END blocks, DECLARE statements, and statement labels for defining program structure, variables, and control flow.

• File Path: 450.reference/300.pl/100.what-is-pl/100.pl-introduction.md

  • Description: PL is a procedural language extension of SQL that enables complex database operations through programming features like loops and logical judgments. It offers high performance, portability, and simplified development by encapsulating business logic within the database.

• File Path: 450.reference/300.pl/100.what-is-pl/200.main-functions-of-pl.md

  • Description: PL combines SQL data processing with procedural language capabilities, supporting variables, control flow, exception handling, and database operations through blocks, packages, and triggers. It enables data abstraction with cursors, composite variables, and control statements for efficient multi-row query processing.

• File Path: 450.reference/300.pl/100.what-is-pl/300.pl-architecture.md

  • Description: This document describes the PL engine architecture and its interaction with the SQL engine, detailing its six core modules: Parser, Resolver, Code Generator, Compiler, Executor, and PL Cache. It explains the complete compilation and execution process for PL procedures and functions.

• File Path: 450.reference/300.pl/1000.pl-system-package/100.system-package-overview.md

  • Description: This document provides an overview of seekdb's PL system packages, which extend database functionality through encapsulated program objects like stored procedures, functions, and variables. It includes descriptions of specific packages such as DBMS_STATS and DBMS_RESOURCE_MANAGER for managing statistics and resource plans.

• File Path: 450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/100.dbms-mview-stat-overview.md

  • Description: This document describes the DBMS_MVIEW_STATS package, which provides subprograms for managing the collection, retention, and configuration of materialized view refresh statistics. It covers procedures for purging old statistics, setting collection parameters, and configuring system defaults.

• File Path: 450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/200.purge-refresh-stats.md

  • Description: This procedure forcibly deletes refresh statistics for materialized views that exceed a specified retention period, with configurable parameters for view name and retention duration.

• File Path: 450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/300.set-mvref-stats-params.md

  • Description: Configures statistics collection levels and retention periods for materialized view refreshes. Allows setting collection granularity (NONE/TYPICAL/ADVANCED) and data retention duration (1-365000 days or permanent).

• File Path: 450.reference/300.pl/1000.pl-system-package/10050.dbms-mview-stat/400.set-system-default.md

  • Description: This procedure sets the system default value for the refresh statistics parameter, allowing configuration of collection level and retention period. It supports values for COLLECTION_LEVEL and RETENTION_PERIOD parameters.

• File Path: 450.reference/300.pl/1000.pl-system-package/13200.dbms_partition/100.dbms_partition-overview.md

  • Description: This document describes the DBMS_PARTITION system package for dynamic partition management, including the MANAGE_DYNAMIC_PARTITION subprogram for creating future partitions and dropping expired ones.

• File Path: 450.reference/300.pl/1000.pl-system-package/13200.dbms_partition/200.manage_dynamic_partition.md

  • Description: Performs dynamic partition management tasks to precreate future partitions and delete expired partitions for dynamic partition tables. Allows optional specification of precreation time intervals and time units for targeted operations.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/100.dbms-resource-manager-overview.md

  • Description: This package provides procedures for managing database resource allocation through resource plans, consumer groups, and directives. It requires the ADMINISTER_RESOURCE_MANAGER privilege to execute its subprograms.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/200.create-consumer-group.md

  • Description: This procedure creates a resource consumer group for database resource management, accepting a group name and optional comment as parameters.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/300.create-plan.md

  • Description: Creates a resource plan with specified name and optional comments using the DBMS_RESOURCE_MANAGER package.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/400.create-plan-directive.md

  • Description: This procedure creates a resource plan directive for managing CPU, I/O, and network bandwidth allocations within database resource groups. It allows administrators to define specific resource limits and weights for groups or subplans within a resource management plan.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/500.delete-consume-group.md

  • Description: This procedure deletes a specified consumer group using the DBMS_RESOURCE_MANAGER package. It requires the consumer group name as input and removes the group from the resource manager configuration.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/600.delete-plan.md

  • Description: Deletes a specified resource plan and all associated plan directives. This procedure removes the plan and its referenced directives from the resource manager.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/700.delete-plan-directive.md

  • Description: This procedure deletes a resource plan directive by specifying the plan name and group or subplan identifier. It is part of the DBMS_RESOURCE_MANAGER package for managing database resource allocation.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/800.set-consumer-group-mappingn-directive.md

  • Description: This procedure manages mappings that assign database sessions to resource consumer groups based on login attributes and runtime functions. It supports creating, updating, and deleting mappings for user sessions and background operations like compaction and DDL tasks.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/900.update-plan-directive.md

  • Description: This procedure updates resource plan directives for managing CPU, I/O, and network bandwidth allocations. It allows modification of parameters including utilization limits, IOPS settings, and bandwidth controls for resource groups or subplans.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/100.dbms-stats-overview.md

  • Description: The DBMS_STATS package manages optimizer statistics for database objects, providing procedures to collect, modify, delete, export, import, and restore statistics at various levels including tables, indexes, columns, and schemas. It also handles statistics locking, preferences, and historical data retention.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1000.drop-stat-table.md

  • Description: This procedure drops a user's statistics table, requiring the username and table name as parameters along with appropriate permissions.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1100.export-column-stats.md

  • Description: Exports column-level statistics from a database table to a user-defined statistics table, requiring ownership of the table and supporting partitioned tables.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1200.export-index-stats.md

  • Description: Exports statistics for a specified index to a user statistics table, including parameters for ownership, partition details, and destination table. Requires appropriate user privileges and handles partitioned indexes.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1300.export-table-stats.md

  • Description: Exports table-level statistics to a user-defined table, including optional column statistics and partition-level data. Requires ownership of the target table and supports parameter customization for user, table, and storage specifications.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1400.export-schema-stats.md

  • Description: Exports statistics for all tables within a specified schema to a user-defined table. Requires appropriate privileges and compatible character sets between databases.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1500.flush-database-monitoring-info.md

  • Description: This procedure refreshes in-memory monitoring information for all database tables, immediately updating statistics views without waiting for scheduled refreshes.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1600.gather-index-stats.md

  • Description: This procedure collects index statistics for Oracle databases, detailing syntax, parameters, and usage examples for effective index analysis.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1700.gather-table-stats.md

  • Description: This procedure collects statistics for a table and its columns, including optional parameters for sampling methods, granularity, and parallel execution.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1800.gather-schema-stats.md

  • Description: This procedure collects statistics for all objects in a specified schema, with configurable parameters for sampling methods, granularity, parallelism, and other statistical options.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1850.gather-system-stats.md

  • Description: This procedure collects system statistics including CPU speed, disk I/O performance, and network throughput. It requires connection as a specified user and handles incorrect statistics name errors.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1900.get-stats-history-availability.md

  • Description: Returns the earliest available timestamp for historical statistics, indicating how far back statistical data can be restored.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/200.alter-stats-history-retention.md

  • Description: This procedure modifies the retention period for historical statistics, with a default of 31 days, using a single parameter to specify the duration in days.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2000.get-stats-history-retention.md

  • Description: This function retrieves the current retention period setting for historical statistics in the database system.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2100.get-param.md

  • Description: Retrieves default parameter values for the DBMS_STATS package procedures. The function accepts a parameter name and returns its configured default value.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2200.get-prefs.md

  • Description: Retrieves default values for specified database statistics preferences, allowing optional specification of user and table parameters. The function returns preference values as strings and handles invalid inputs through standard exceptions.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2300.import-index-stats.md

  • Description: The IMPORT_INDEX_STATS procedure retrieves index statistics from a user statistics table and stores them in the dictionary, allowing users to import previously saved index statistics with various configuration options.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2400.import-column-stats.md

  • Description: Imports column-level statistics from a user statistics table into the database. This procedure allows for granular control over statistics importation, including handling partitioned tables and locked statistics.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2500.import-table-stats.md

  • Description: Imports table-level statistics from a user statistics table, including column and index statistics, with options to handle partitions, locks, and plan cache invalidation.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2600.import-schema-stats.md

  • Description: Imports statistics for all tables in a specified schema from a user statistics table, allowing control over plan cache invalidation and lock status handling.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2700.lock-partition-stats.md

  • Description: This procedure locks statistics for a specified table partition, requiring the user to be the table owner. It accepts parameters for the username, table name, and partition name.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2800.lock-schema-stats.md

  • Description: This procedure locks statistics for all tables in a specified schema, preventing modifications to table, column, index, and histogram statistics through various DBMS_STATS operations.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2900.lock-table-stats.md

  • Description: This procedure locks table statistics to prevent modifications, requiring ownership and affecting all dependent objects including columns and indexes. It supports multiple lock types and applies at the table level.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/300.create-stat-table.md

  • Description: Creates a table in the specified schema for storing statistics, with configurable parameters for tablespace and user.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3000.restore-table-stats.md

  • Description: Restores table-level historical statistics from a specified timestamp, allowing users to recover previous statistical data with optional parameters for forced restoration and plan cache management.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3100.restore-schema-stats.md

  • Description: Restores schema-level statistics from a specified historical timestamp, allowing recovery of previous optimizer statistics for all objects within a schema.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3200.reset-global-pref-defaults.md

  • Description: This procedure resets all global Prefs to their default values using the DBMS_STATS package.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3300.reset-param-defaults.md

  • Description: This procedure resets all parameter defaults to the values recommended by seekdb. It is called using the syntax DBMS_STATS.RESET_PARAM_DEFAULTS.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3400.purge-stats.md

  • Description: Deletes historical statistics recorded before a specified timestamp, using either manual time specification or automatic purge strategy when set to NULL.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3500.set-column-stats.md

  • Description: This procedure sets column-level statistics including distinct values, density, null counts, and average column length for database tables. It requires table ownership and supports partitioned tables with optional plan cache invalidation controls.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3600.set-index-stats.md

  • Description: Sets index statistics including row count, average length, and block information for database optimization. Requires table ownership and allows optional parameters for partition handling and cache invalidation control.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3700.set-table-stats.md

  • Description: This procedure sets table-level statistics including row counts, block usage, and average row length for database optimization. It allows overriding locked statistics and controlling plan cache invalidation during updates.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3800.set-global-prefs.md

  • Description: This procedure sets global statistics preferences for the database by allowing users to specify preference names and their corresponding values. It handles configuration of database-wide statistical parameters through two VARCHAR2 input parameters.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3900.set-param.md

  • Description: Sets the default value of a specified parameter for procedures in the DBMS_STATS package. Requires SYSDBA privileges and accepts two VARCHAR2 parameters for the parameter name and its new value.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/400.delete-column-stats.md

  • Description: This procedure deletes column-level statistics for database tables, including options to remove histograms, handle partitioned data, and override locks. It requires appropriate user privileges and supports granular control over statistic deletion.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4000.set-schema-prefs.md

  • Description: Sets statistics preferences for a specified schema, allowing configuration of parameters like degree of parallelism. Requires executing as the schema owner with all parameters provided as quoted strings.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4050.set-system-stats.md

  • Description: Sets system statistics parameters including CPU, disk, and network speeds. Requires appropriate user privileges to execute.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4100.set-table-prefs.md

  • Description: Sets statistics preferences for a specified user's table, allowing configuration of parameters like degree of parallelism for data collection. Requires proper user privileges and valid input values for table name, preference name, and preference value.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4200.unlock-partition-stats.md

  • Description: Unlocks statistics for a specified table partition, requiring ownership of the table. The procedure accepts parameters for username, table name, and partition name.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4300.unlock-schema-stats.md

  • Description: Unlocks statistics for all tables in a specified schema, allowing modifications to table, column, and index statistics that were previously locked.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4400.unlock-table-stats.md

  • Description: This procedure unlocks table-level statistics, allowing modifications to statistics for the specified table and its dependent objects. It requires table ownership and supports different lock types including ALL, DATA, and CACHE.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4500.cancel-gather-status.md

  • Description: Cancels an ongoing statistics collection task by specifying the task ID, which can be obtained from the GV$OB_OPT_STAT_GATHER_MONITOR view.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/500.delete-index-stats.md

  • Description: This procedure deletes statistics for a specified index, with options to handle partitions, plan cache invalidation, and locked statistics. It requires appropriate user privileges and supports explicit table name specification when needed.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/600.delete-table-stats.md

  • Description: This procedure deletes table-level statistics and optionally removes related partition and column statistics. It includes parameters for controlling cascading deletion, plan cache invalidation, and forced execution.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/700.delete-schema-stats.md

  • Description: Deletes statistics for all tables in a specified schema, with options to control plan cache invalidation and ignore locked statistics. Requires schema ownership privileges to execute.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/800.delete-schema-prefs.md

  • Description: Deletes statistics preferences for all tables in a specified schema, requiring schema name and preference name as parameters. This procedure requires proper user privileges and valid input values.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/860.delete-system-stats.md

  • Description: This procedure deletes all system statistics and requires no parameters, though it must be executed by the specified user.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/900.delete-table-prefs.md

  • Description: This procedure deletes statistics preferences for specified database tables, requiring user credentials and preference names as input parameters. It handles permission validation and parameter enforcement during execution.

• File Path: 450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/100.dbms-udr-overview.md

  • Description: The DBMS_UDR package enables SQL statement rewriting through user-defined rules before execution, supporting SELECT, INSERT, UPDATE, DELETE, MERGE, REPLACE, and SET statements. It includes subprograms for creating, enabling, disabling, and removing rules, with matching based on placeholder syntax for constant parameters.

• File Path: 450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/200.create-rule.md

  • Description: This document describes the CREATE_RULE procedure for creating custom SQL rewrite rules, including syntax, parameters, usage limitations, and examples. It covers how to define patterns and replacements to transform specific SQL statements.

• File Path: 450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/300.disable-rule.md

  • Description: This procedure deactivates a custom rewrite rule by name, rendering it ineffective for query optimization.

• File Path: 450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/400.enable-rule.md

  • Description: This procedure enables a custom rewrite rule to take effect, requiring only the rule name as input.

• File Path: 450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/500.remove-rule.md

  • Description: This procedure deletes a custom rewrite rule by name, removing it from the database system.

• File Path: 450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/100.dbms-vector-overview.md

  • Description: This document covers the DBMS_VECTOR package for managing vector indexes, including subprograms for refreshing, rebuilding, and analyzing memory usage of these indexes.

• File Path: 450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/200.refresh-index.md

  • Description: This procedure incrementally refreshes vector indexes by specifying parameters like index name, table name, and refresh threshold, with optional FAST refresh type.

• File Path: 450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/300.rebuild-index.md

  • Description: This procedure fully rebuilds a vector index, allowing users to specify parameters like the index name, table name, vector column, and optional settings for threshold, distance metrics, and parallelism.

• File Path: 450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/400.index-vector-memory-estimate.md

  • Description: Estimates memory usage for vector indexes on specified table columns, requiring updated statistics via ANALYZE TABLE prior to execution. Supports multiple index types including HNSW and IVF variants, returning minimum memory requirements for index creation and search operations.

• File Path: 450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/500.index-vector-memory-advisor.md

  • Description: Estimates memory requirements for creating vector indexes, providing recommended minimum values and actual post-construction memory usage for various index types.

• File Path: 450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/100.dbms-workload-repository-overview.md

  • Description: This package manages the Automatic Workload Repository (AWR), providing functions to create snapshots, modify settings, generate reports, and delete snapshot ranges. All subprograms require the EXECUTE privilege.

• File Path: 450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/200.ash-report.md

  • Description: Generates an ASH report in text or HTML format by sampling active session history data within a specified time range, with optional filters for SQL statements, trace IDs, and wait classes.

• File Path: 450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/300.create-snapshot.md

  • Description: This procedure triggers manual snapshot generation for cluster performance data, resetting the automatic snapshot timer. It supports TYPICAL snapshots that collect comprehensive statistical information.

• File Path: 450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/400.drop-snapshot-range.md

  • Description: This procedure deletes a range of database snapshots by specifying the low and high snapshot IDs to be removed.

• File Path: 450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/500.modify-snapshot-settings.md

  • Description: This procedure modifies the retention period and interval settings for the WORKLOAD_REPOSITORY snapshots, controlling how long snapshots are stored and how frequently they are captured.

• File Path: 450.reference/300.pl/1000.pl-system-package/9000.dbms-hybrid-search/100.dbms-hybrid-search-overview.md

  • Description: This document covers the DBMS_HYBRID_SEARCH package for managing hybrid vector indexes, including subprograms for retrieving search results and generating SQL statements.

• File Path: 450.reference/300.pl/1000.pl-system-package/9000.dbms-hybrid-search/200.search.md

  • Description: This document details the SEARCH function, which returns JSON-formatted results ordered by relevance for both full-text and vector retrieval, including hybrid search and ranking strategies. It provides comprehensive syntax, parameter definitions, and structure for the search_params JSON input.

• File Path: 450.reference/300.pl/1000.pl-system-package/9000.dbms-hybrid-search/300.get_sql.md

  • Description: Returns the executed SQL statement as a string, detailing the function's syntax, parameters, and JSON-based search structure for full-text and vector retrieval.

• File Path: 450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/100.dbms-mview-overview.md

  • Description: This document describes the DBMS_MVIEW package, which provides subprograms for refreshing materialized views and purging materialized view logs.

• File Path: 450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/200.purge-log.md

  • Description: Clears a materialized view log to reduce its size by deleting all associated log records. The procedure requires the master table name as input.

• File Path: 450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/300.refresh.md

  • Description: This document describes the REFRESH procedure for refreshing materialized views, including syntax, parameter descriptions for refresh methods and nested view handling, and usage examples.

• File Path: 450.reference/300.pl/1100.pl-reserved-keywords.md

  • Description: This document lists PL reserved and non-reserved keywords, detailing which identifiers have special meanings and cannot be used for naming procedures, functions, and other elements, while non-reserved keywords can be used without quotation marks.

• File Path: 450.reference/300.pl/200.storage-object/100.pl-storage-objects-overview.md

  • Description: This document provides an overview of stored programs in seekdb, including stored procedures, stored functions, and triggers. It describes their creation, invocation, and usage for database operations.

• File Path: 450.reference/300.pl/200.storage-object/200.variables-in-stored-programs.md

  • Description: Explains how to declare and use local variables, system variables, and parameters within stored programs, including their scope, resolution, and assignment methods. Covers syntax, data types, and practical considerations for variable usage.

• File Path: 450.reference/300.pl/200.storage-object/300.pl-stored-procedure.md

  • Description: This document explains how to create and use stored procedures in PL/SQL, covering their structure, parameter types (IN, OUT, INOUT), and calling methods with practical examples.

• File Path: 450.reference/300.pl/200.storage-object/350.pl-stored-routines-privileges.md

  • Description: This document covers the management of stored procedures and functions in seekdb, including required privileges like CREATE ROUTINE, EXECUTE, and ALTER ROUTINE. It also explains security contexts, DEFINER specifications, and handling of orphan objects.

• File Path: 450.reference/300.pl/200.storage-object/400.pl-storage-function.md

  • Description: This document explains stored functions in MySQL, covering their structure with required RETURNS clauses and demonstrating creation using CREATE FUNCTION statements with return value specifications.

• File Path: 450.reference/300.pl/200.storage-object/500.pl-trigger.md

  • Description: This document explains database triggers in seekdb, covering their creation, types (INSERT, UPDATE, DELETE), syntax, and limitations. It also details how to view trigger metadata and provides practical examples.

• File Path: 450.reference/300.pl/200.storage-object/550.pl-event.md

  • Description: This document describes events in seekdb, which are predefined SQL tasks that automatically execute at scheduled times or intervals. It covers event creation, scheduling rules, supported SQL operations, and management features like dynamic control and privilege requirements.

• File Path: 450.reference/300.pl/200.storage-object/600.pl-stored-program-usage-restrictions.md

  • Description: This document outlines limitations for stored routines (procedures and functions) and triggers, covering SQL statement restrictions, function-specific constraints, trigger limitations, and identifier resolution rules.

• File 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 syntax, declaration requirements, and key attributes including insensitivity, read-only access, and non-scrollable behavior.

• File Path: 450.reference/300.pl/300.cursor/200.cursor-execution-process.md

  • Description: This document details the complete SQL cursor execution process, including the syntax and usage for declaring, opening, fetching from, and closing a cursor. It provides a practical example demonstrating how to implement cursors within a stored procedure.

• File Path: 450.reference/300.pl/300.cursor/300.cursor-usage-limits.md

  • Description: This document outlines the limitations of server-side cursors in MySQL, including their read-only nature, non-holdable behavior, and restrictions on scrollability and naming. It also specifies which statement types are incompatible with cursor usage.

• File Path: 450.reference/300.pl/400.control-statement/100.CASE.md

  • Description: This document explains the CASE statement syntax for constructing conditional logic in SQL, detailing two distinct formats and their execution behaviors. It covers syntax rules, NULL handling considerations, and error conditions when no matching cases are found.

• File Path: 450.reference/300.pl/400.control-statement/200.IF.md

  • Description: This document explains the syntax and usage of the SQL IF statement for constructing conditional logic, including THEN, ELSEIF, and ELSE clauses with execution rules and nesting examples.

• File Path: 450.reference/300.pl/400.control-statement/300.ITERATE.md

  • Description: Restarts a loop statement and can only be used within LOOP, REPEAT, and WHILE statements.

• File Path: 450.reference/300.pl/400.control-statement/400.LEAVE.md

  • Description: The LEAVE statement exits labeled control-flow statements or stored programs, and can be used within various loop types and BEGIN...END blocks.

• File Path: 450.reference/300.pl/400.control-statement/500.LOOP.md

  • Description: This document describes the LOOP statement for creating simple loops in SQL, including its syntax and usage with termination statements like LEAVE and ITERATE to control loop execution.

• File Path: 450.reference/300.pl/400.control-statement/600.REPEAT.md

  • Description: Describes the REPEAT statement syntax and usage for executing SQL statements repeatedly until a condition becomes true, including an example implementation.

• File Path: 450.reference/300.pl/400.control-statement/700.RETURN.md

  • Description: This document explains the RETURN statement, which terminates stored functions and returns results to the caller. It covers syntax, usage requirements, and clarifies that stored procedures and triggers use LEAVE instead.

• File Path: 450.reference/300.pl/400.control-statement/800.WHILE.md

  • Description: The WHILE statement constructs conditional loops that repeatedly execute SQL statements while a search condition remains true. It supports labeled syntax and statement lists terminated with semicolons.

• File Path: 450.reference/300.pl/500.pl-manipulation-statement-mysql/100.call.md

  • Description: This document explains the CALL statement for invoking stored procedures, covering syntax variations for procedures with and without parameters. It details how to handle OUT and INOUT parameters for returning values and demonstrates usage through practical examples.

• File Path: 450.reference/300.pl/500.pl-manipulation-statement-mysql/200.do.md

  • Description: Executes SQL expressions without returning results, providing a quick response equivalent to SELECT statements when output is not needed.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/100.alter-function.md

  • Description: This document explains the ALTER FUNCTION statement for modifying stored function characteristics like security settings and data usage, while noting it cannot change parameters or function bodies. It covers required privileges and provides syntax examples.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/1000.drop-trigger.md

  • Description: This document covers the DROP TRIGGER SQL statement syntax and usage for deleting database triggers, including optional clauses and privilege requirements.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/200.alter-procedure.md

  • Description: This document explains the ALTER PROCEDURE statement for modifying stored procedure characteristics such as SQL security, data access patterns, and comments, while noting it cannot change parameters or procedure bodies.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/500.create-function.md

  • Description: This document explains how to create stored functions using the CREATE FUNCTION statement, covering required privileges, syntax, parameters, return types, and security characteristics. It includes usage examples and details about routine definitions and execution contexts.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/600.create-procedure.md

  • Description: Creates stored procedures with specified parameters, characteristics, and security contexts, detailing syntax, privilege requirements, and execution behaviors. Covers parameter types (IN/OUT/INOUT), routine bodies, and definer/invoker security models.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/700.create-trigger.md

  • Description: This document explains the CREATE TRIGGER statement syntax for creating database triggers that activate before or after specified table operations (INSERT, UPDATE, DELETE). It covers trigger structure, naming requirements, privilege considerations, and the use of OLD/NEW aliases in trigger bodies.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/800.drop-function.md

  • Description: Removes a stored function from the database, requiring ALTER ROUTINE privilege and optionally preventing errors with the IF EXISTS clause.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/900.drop-procedure.md

  • Description: This document explains the DROP PROCEDURE statement syntax and usage for removing stored procedures, including the optional IF EXISTS clause and required user privileges.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/100.show-create-function.md

  • Description: Displays the SQL statement used to create a specified stored function, including function metadata and creation context. Requires appropriate user privileges to view the complete definition.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/200.show-create-procedure.md

  • Description: Displays the CREATE PROCEDURE statement and metadata for a stored procedure, including SQL mode, character set, and collation information. Requires specific privileges to view the complete definition.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/300.show-create-trigger.md

  • Description: Displays the CREATE TRIGGER statement used to create a specified trigger, including execution details and metadata such as SQL mode, character sets, and creation timestamp.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/400.show-function-status.md

  • Description: Displays information about stored functions including database, name, type, creator, dates, and character set details. Requires appropriate privileges and supports filtering with LIKE or WHERE clauses.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/500.show-procedure-status.md

  • Description: Displays information about stored procedures including database, name, type, creator, dates, and character set details. Requires appropriate privileges and supports filtering with LIKE or WHERE clauses.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/600.show-triggers.md

  • Description: Displays triggers defined for database tables, including their names, events, associated tables, and creation details. The statement supports filtering by database and table patterns using LIKE or WHERE clauses.

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/100.information-schema-parameters.md

  • Description: This dictionary view provides metadata about stored routine parameters and function return values, detailing their data types, modes, and other attributes through fields like ORDINAL_POSITION, PARAMETER_MODE, and DATA_TYPE.

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/200.information-schema-routines.md

  • Description: Provides metadata about stored procedures and functions, including their names, definitions, and characteristics, while excluding built-in and loadable functions.

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/300.information-schema-triggers.md

  • Description: This view provides metadata about database triggers, including their names, associated tables, activation events, timing, and creation details. Access requires the TRIGGER privilege on the relevant tables.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/100.exception-handling-statement.md

  • Description: This document covers exception handling statements in seekdb's stored programs, including DECLARE CONDITION, DECLARE HANDLER, RESIGNAL, SIGNAL, and GET DIAGNOSTICS. It explains handler selection rules and the diagnostic area for managing program errors and warnings.

• File 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 and special handling of SQLSTATE values.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/200.declare-condition.md

  • Description: Declares named exception conditions for error handling in stored programs, associating names with either MySQL error codes or SQLSTATE values for improved code readability.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/300.declare-handler.md

  • Description: Specifies handlers for exception conditions in stored programs, defining actions to execute when specific errors or warnings occur. Covers handler types, condition values, and execution behaviors with practical examples.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/400.get-diagnostics.md

  • Description: This document explains the GET DIAGNOSTICS SQL statement for retrieving diagnostic information about SQL statement execution, including syntax, parameters, and practical usage examples for both current and stacked diagnostic areas.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/500.resignal.md

  • Description: The RESIGNAL statement passes or modifies error condition information within stored program handlers, allowing manipulation of diagnostic areas and signal information items like SQLSTATE values and message text. It requires execution within an active condition handler context and operates similarly to SIGNAL but works with existing errors rather than initiating new ones.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/600.signal.md

  • Description: The SIGNAL statement explicitly returns errors with customizable SQLSTATE values, messages, and error codes, typically used in stored programs to control error handling and reporting. It supports both direct SQLSTATE references and named conditions, with syntax rules for signal information items and execution impacts based on error categories.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/700.scope-rules-for-handlers.md

  • Description: This document outlines the scope and activation rules for handlers in seekdb stored programs, including how handler position, condition specificity, and block nesting determine which handler executes when conditions occur. It provides detailed rules and examples for handler precedence based on error codes, SQLSTATE values, and general condition categories.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/800.diagnostic-area.md

  • Description: Explains the structure and management of SQL diagnostic areas, including statement and condition information items, clearing/filling procedures, and stack operations during stored program execution. Covers standard SQL features and MySQL extensions for error handling.

• File 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 stored procedures prevent OUT and INOUT parameters from returning modified values to the caller.

Error Code

• File Path: 450.reference/600.error-code/100.error-code-overview.md

  • Description: This document provides an overview of seekdb's error message format, structure, and categorization, detailing how error codes are organized by functional ranges and their compatibility with MySQL standards.

• File Path: 450.reference/600.error-code/1000.9500-9999.md

  • Description: This document covers process language (PL) error codes 9500–9999, detailing common error reasons and solutions for issues such as parameter usage, object references, and type mismatches in PL/SQL contexts.

• File Path: 450.reference/600.error-code/1050.10000-12000.md

  • Description: This document covers error codes 10000–12000 for OBKV and client operations, detailing common issues related to routing, TTL configuration, HBase table settings, data type mismatches, and access permissions.

• File Path: 450.reference/600.error-code/1100.22998-30926-38104-38105.md

  • Description: This documentation covers error codes related to BLOB and CLOB data types, SQL function limitations, and database operation constraints including row stability and update restrictions.

• File Path: 450.reference/600.error-code/200.0001-3999.md

  • Description: This document provides a comprehensive list of error codes 0001–3999, detailing their compatibility with MySQL and corresponding seekdb error codes for database operations and troubleshooting.

• File Path: 450.reference/600.error-code/300.4000-4499.md

  • Description: This document provides descriptions and solutions for general error codes 4000–4499 in the seekdb system, covering issues like timeouts, memory limits, and system errors.

• File Path: 450.reference/600.error-code/500.5000-5999.md

  • Description: Covers SQL layer error codes 5000-5999, including parsing, type conversion, plan generation, and privilege management issues with corresponding solutions.

• File Path: 450.reference/600.error-code/600.6000-6999.md

  • Description: This document covers error codes 6000-6999 for the object layer, detailing transaction, MVCC, and clog errors with causes and solutions.

• File Path: 450.reference/600.error-code/800.8000-8999.md

  • Description: This document covers error codes 8000-8999 for seekdb, which indicate serious system errors requiring SQL connection closure. It includes specific codes for server initialization, shutdown, and packet checksum issues with corresponding solutions.

Telemetry

• File Path: 450.reference/700.telemetry/700.telemetry.md

  • Description: seekdb includes an optional telemetry feature that anonymously collects technical usage data to help improve the product, while protecting privacy by hashing sensitive information. Users can control telemetry through an environment variable and view collected data locally.

Sdk

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/10.pyseekdb-sdk-get-started.md

  • Description: pyseekdb is a Python client for connecting to seekdb in embedded or remote modes, supporting both seekdb server mode and OceanBase Database. It is compatible with Linux, macOS, and Windows, and includes installation instructions and API references for database operations.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/10.pyseekdb-simple-sample.md

  • Description: This document provides a simple example demonstrating how to use Embedding Functions in pyseekdb's embedded mode, covering collection creation, data insertion with automatic vector generation, and text-based querying.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/100.pyseekdb-hybrid-search-sample.md

  • Description: Demonstrates hybrid_search() capabilities for combining full-text and vector searches with independent filtering and RRF result fusion, showing advantages over basic query() functionality.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/50.pyseekdb-complete-sample.md

  • Description: Complete example demonstrating pyseekdb's full capabilities including connection modes, collection management, DML operations (add/update/upsert/delete), DQL operations (query/get/hybrid search), and filter operators.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/5.pyseekdb-changelog.md

  • Description: This changelog documents pyseekdb V1.1.0, featuring expanded collection name lengths, full-text search capabilities, broader embedding platform support, and an experimental table-fork feature for collection snapshots.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/10.api-overview.md

  • Description: This API reference covers seekdb's database management, collection operations, and data manipulation/query interfaces including vector search and hybrid search capabilities.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/100.admin-client.md

  • Description: The AdminClient provides database management operations for embedded and remote seekdb instances, supporting connections to both seekdb and OceanBase Database with APIs for creating, querying, deleting, and listing databases.

• File 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 database management, covering the creation, querying, and deletion of databases, and details the available API operations for these tasks.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/200.create-database-of-api.md

  • Description: This function creates a new database using default properties, requiring AdminClient connection and appropriate user privileges.

• File 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() method for retrieving information about a specific database, including its parameters, usage examples, and response format. It requires AdminClient connection and pyseekdb installation.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/400.list-database-of-api.md

  • Description: This API method retrieves a list of databases from the instance with optional pagination parameters, available exclusively through the AdminClient interface.

• File 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 for deleting databases using the AdminClient in pyseekdb, including prerequisites, required parameters, and usage examples.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/100.create-collection-of-api.md

  • Description: This document explains how to use the create_collection() API to create new database tables, detailing required parameters, naming conventions, and embedding function configurations.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/200.get-collection-of-api.md

  • Description: Retrieves a specified collection from the database, allowing optional configuration of index parameters and embedding functions. This function requires an existing collection name and returns collection details including dimension, distance metric, and embedding function.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/250.get-or-create-collection-of-api.md

  • Description: This API function creates a new collection or retrieves an existing one in the database, with configurable parameters for indexing and embedding functions. It requires client-side usage and proper user privileges for database operations.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/300.list-collection-of-api.md

  • Description: This API retrieves all collections from the database, returning details including name, dimension, embedding function, distance metric, and metadata. It requires pyseekdb installation and an active database connection through the Client.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/350.count-collection-of-api.md

  • Description: This API method counts the number of collections in a database using the pyseekdb Client, requiring an active database connection and proper SDK installation.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/400.delete-collection-of-api.md

  • Description: This API method deletes a specified collection from the database, requiring a valid collection name and an active client connection.

• File 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 API interfaces for managing collections in pyseekdb, including methods to create, query, list, count, and delete collections.

• File 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 DML (Data Manipulation Language) operations for inserting, updating, and deleting data in a collection, detailing the available APIs for each function.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/300.dml/200.add-data-of-api.md

  • Description: The add() method inserts new data into a collection, supporting various input formats including IDs, embeddings, documents, and metadata. It requires client usage and proper database privileges, returning an error if duplicate IDs exist.

• File 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 for modifying existing records in a collection, including parameters for updating IDs, embeddings, documents, and metadata. It requires client mode and provides Python code examples for single and multiple record updates.

• File 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 for inserting new records or updating existing records in a database, including required parameters and usage examples. It covers prerequisites, request parameters, and implementation details for the upsert operation.

• File 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 method for removing records from a collection using ID, metadata filters, or document content filters, including prerequisites and usage examples.

• File 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 DQL (Data Query Language) operations, detailing the supported API interfaces for retrieving data from collections, including vector similarity search, ID-based queries, and hybrid search methods.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/200.query-interfaces-of-api.md

  • Description: This document describes the query() method for performing vector similarity searches, including parameter specifications, usage examples, and return values. It covers both direct vector queries and text-based queries using embedding functions.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/300.get-interfaces-of-api.md

  • Description: Retrieves documents from a collection using ID-based lookup or metadata/document filtering without vector similarity search. Supports pagination, field selection, and returns results based on provided identifiers or filter criteria.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/400.hybrid-search-of-api.md

  • Description: Combines full-text and vector similarity search with configurable ranking, requiring prior collection setup and data insertion. Returns ranked results including documents, metadata, and embeddings.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/400.dql/500.filter-operators-of-api.md

  • Description: This document covers filter operators for data and text filtering in API queries, including comparison, logical, and full-text search operators with syntax examples.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/50.client.md

  • Description: The Client class connects to embedded or remote databases, including seekdb and OceanBase Database, and supports collection management APIs. It automatically selects the appropriate connection mode based on provided parameters.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/100.default-embedding-function-of-api.md

  • Description: This document describes the default embedding function in pyseekdb, which automatically converts text into vector embeddings for similarity search using a preconfigured model. It also provides guidance on using custom embedding functions.

• File 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 custom embedding functions by implementing the EmbeddedFunction protocol, including required methods and optional dimension attributes, with practical examples using Sentence Transformers and OpenAI APIs.

• File 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 custom embedding functions when creating or retrieving collections, enabling automatic vector generation for documents and queries. It includes Python code examples for collection operations with custom embeddings.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/100.amazon-bedrock-py.md

  • Description: Amazon Bedrock is a managed foundation model platform on AWS, and this document provides a wrapper for generating embeddings via Bedrock to use with seekdb collections. It covers dependencies, authentication, and includes an example for creating the embedding function.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/1000.tencent-hunyuan-py.md

  • Description: Tencent Hunyuan is a general-purpose large language model with strong capabilities in content generation, math, logic, and dialogue. This document covers its embedding API for converting text into 1024-dimensional vectors, along with installation, authentication, and usage examples for the Python implementation.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/1100.voyageai-py.md

  • Description: This document details the VoyageaiEmbeddingFunction for integrating Voyage AI embedding models into pyseekdb, enabling semantic search for RAG, agent memory, and related applications. It covers installation, authentication, and configuration options including model selection, input types, and dimension reduction.

• File 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 for integrating Cohere's embedding models into seekdb collections, including setup, authentication, and usage examples for semantic search applications.

• File 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 explains how to use the GoogleVertexEmbeddingFunction wrapper to generate text embeddings via Google Vertex AI for use with seekdb collections, including required dependencies, authentication, and implementation parameters.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/400.jina-ai-py.md

  • Description: Provides a JinaEmbeddingFunction wrapper for generating Jina AI embeddings within seekdb collections, requiring a Jina API key and supporting multiple model configurations.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/500.ollama-py.md

  • Description: This document covers the OllamaEmbeddingFunction wrapper for generating embeddings using Ollama's OpenAI-compatible API, including setup requirements and configuration parameters for local and remote servers.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/600.openai-py.md

  • Description: OpenAI embedding models convert text into semantic vectors for similarity measurement and applications like search and classification. This documentation covers setup, authentication, and usage examples for the OpenAIEmbeddingFunction in Python.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/700.qwen-py.md

  • Description: Qwen embedding models provide text embedding and ranking capabilities across 100+ languages, supporting long contexts and dynamic dimension outputs. This documentation covers installation, authentication, and usage examples for integrating these models via the Dashscope API.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/800.sentence-transformer-py.md

  • Description: A framework for converting sentences into vector embeddings using pre-trained Transformer models, enabling semantic similarity comparisons for tasks like search and clustering. Includes local model handling and integration with PySeekDB for embedding-based data storage.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/400.embedding-function-wrapper-py/900.siliconflow-py.md

  • Description: SiliconFlow is a cloud platform hosting open-source foundation models, offering semantic embedding services for RAG, search, and recommendation workloads. This documentation covers setup, authentication, and usage examples for its Python embedding function with configurable parameters.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/60.embedding-funcations/50.ef-overview-py.md

  • Description: This document explains how embedding functions convert text to vectors for semantic search in seekdb, covering built-in providers, default settings, and custom implementation options.

• File Path: 450.reference/900.sdk/20.seekdb-js/10.seekdb-js-get-started.md

  • Description: A Node.js client for connecting to OceanBase Database or remote servers in server mode, providing APIs for database operations and hybrid search capabilities.

• File 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 demonstrating how to use SeekDB's server mode with embedding functions for automatic vector generation, document storage, and semantic text queries. It covers connecting to the database, creating collections, adding data, querying with text, and viewing results.

• File Path: 450.reference/900.sdk/20.seekdb-js/30.sdk-samples-of-seekdb-js/100.seekdb-js-hybrid-search-sample.md

  • Description: Demonstrates hybrid search capabilities combining full-text and vector similarity searches with independent filtering and result fusion using Reciprocal Rank Fusion. Compares hybridSearch() with query() to show advantages in handling complex search scenarios.

• File Path: 450.reference/900.sdk/20.seekdb-js/30.sdk-samples-of-seekdb-js/50.seekdb-js-complete-sample.md

  • Description: A comprehensive example demonstrating seekdb-js capabilities including client connection, collection management, DML operations (add/update/upsert/delete), DQL operations (query/get/hybridSearch), and filter operators with metadata handling.

• File Path: 450.reference/900.sdk/20.seekdb-js/5.seekdb-js-changelog.md

  • Description: This changelog documents seekdb-js V1.1.0, featuring expanded collection name lengths, full-text search configuration, broader embedding platform support, and an experimental table-fork capability for collection snapshots.

• File Path: 450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/10.api-overview-of-seekdb-js.md

  • Description: This API reference provides documentation for programmatically accessing seekdb, covering database management, collection operations, and data manipulation/querying capabilities. It details available methods for creating, querying, updating, and deleting databases, collections, and records.

• File Path: 450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/100.seekdbadminclient-of-seekdb-js.md

  • Description: The SeekdbAdminClient provides database management operations for seekdb and OceanBase Database, supporting connections to remote servers and APIs for creating, querying, deleting, and listing databases.

• File 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 covers database management operations in SeekDB.js, including creating, querying, listing, and deleting databases through specific API methods.

• File 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 explains how to use the createDatabase() method to create a new database with default properties, including prerequisites, limitations, and usage considerations. It is intended for use with the SeekdbAdminClient and requires proper user privileges and server setup.

• File 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 for retrieving information about a specified database, including its parameters, usage examples, and response structure. It requires a SeekdbAdminClient connection and provides details for both server mode and OceanBase Database implementations.

• File 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 for retrieving database lists from a SeekDB instance, including its parameters, prerequisites, and response structure. It covers usage with SeekdbAdminClient for both server mode and OceanBase Database environments.

• File 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 for removing databases using the SeekdbAdminClient, including prerequisites, parameters, and usage examples.

• File 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 for creating new database collections, including required parameters, configuration options, and usage prerequisites. It covers collection naming rules, vector dimension settings, and embedding function integration.

• File 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: Retrieves a specified collection from the database, allowing optional configuration of embedding functions and returning collection metadata including name, dimension, and distance metrics. Requires an active SeekdbClient connection and prior collection existence.

• File 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: Creates or retrieves a collection in the database, supporting vector configurations and embedding functions for document-to-vector conversion.

• File 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 for creating a new collection with identical data from an existing collection, including prerequisites, parameters, and usage examples.

• File 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 for retrieving all collections in a SeekDB database, including prerequisites, parameters, and return values.

• File 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 method counts the number of collections in a SeekDB database and requires an active SeekdbClient connection to function properly.

• File 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: Checks whether a specified collection exists in the database using the hasCollection() method, which requires a SeekdbClient connection and returns a boolean result.

• File 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: Deletes a specified collection in the SeekDB database using the deleteCollection() method. Requires an active SeekdbClient connection and an existing collection name.

• File 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 covers collection management in seekdb-js, detailing APIs for creating, querying, copying, and deleting collections. It includes methods like createCollection(), getCollection(), fork(), and deleteCollection().

• File 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 DML operations in SeekDB.js, covering data insertion, updating, and deletion through supported APIs including add(), update(), upsert(), and delete().

• File 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: Inserts new data into a collection using provided IDs, embeddings, documents, and metadata, with automatic vector generation if documents are provided without embeddings. Requires SeekdbClient connection and user insert privileges.

• File 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: The update() method modifies existing records in a collection by updating their embeddings, documents, or metadata, requiring valid IDs and SeekdbClient connection.

• File 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: The upsert() method inserts new records or updates existing ones in a SeekDB collection, requiring proper client connection and user privileges. It accepts IDs, embeddings, documents, and metadata as parameters to perform these operations.

• File 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: The delete() method removes records from a collection using ID, metadata filter, or document filter parameters. This operation requires a SeekdbClient connection and appropriate user privileges.

• File 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 outlines DQL operations for retrieving data from collections, including vector similarity search, ID-based queries, and hybrid full-text and vector search methods.

• File 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: Executes vector similarity searches to find documents matching query vectors or text, with options for filtering and result inclusion. Requires a SeekdbClient connection and pre-configured collection with data.

• File 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: Retrieves documents from a collection by ID, metadata, or document content filters without vector similarity search. Supports pagination and field inclusion options.

• File 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: Combines full-text and vector similarity search with ranking, requiring a SeekdbClient connection and supporting configurable parameters for both search types.

• File 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 covers filtering operators for data and text in SeekDB.js, including comparison, logical, and full-text search operators with syntax examples.

• File Path: 450.reference/900.sdk/20.seekdb-js/50.apis-of-seekdb-js/50.seekdbclient-of-seekdb-js.md

  • Description: A unified interface for connecting to both seekdb server mode and OceanBase Database, providing methods for collection management and database operations.

• File 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 covers the default embedding function in seekdb-js, which uses a local model for text-to-vector conversion without requiring an API key. It includes implementation examples for both automatic and manual setup, along with guidance for network configuration and custom function alternatives.

• File Path: 450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/50.ef-overview-js.md

  • Description: This document explains how embedding functions convert text to vectors for semantic search in seekdb, covering built-in providers, default local models, and custom implementation options. It includes usage examples for binding functions to collections and automatic vector generation during ingest and query operations.

• File 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 custom embedding functions by implementing the required interface methods, including generate, getConfig, and buildFromConfig, with code examples provided.

• File 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 custom embedding functions when creating or retrieving collections in SeekDB.js, including code examples for automatic document embedding and text-based queries.

• File 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: Amazon Bedrock is a managed foundation model platform on AWS, and this document provides the AmazonBedrockEmbeddingFunction for generating embeddings with Bedrock models to use with seekdb collections. It covers installation, configuration, authentication requirements, and usage examples.

• File 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: Tencent Hunyuan is a general-purpose large language model developed by Tencent, excelling in content generation, math, logic, code, and dialogue. It includes an embedding API for converting text into 1024-dimensional vectors, with seekdb providing a dedicated embedding function for integration.

• File 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 details the VoyageAIEmbeddingFunction for generating embeddings using Voyage AI models, enabling semantic search and RAG applications in seekdb collections. It covers installation, authentication, and configuration options for the embedding function.

• File Path: 450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/200.cohere-js.md

  • Description: The CohereEmbeddingFunction integrates Cohere's embedding models with seekdb collections for semantic search and other applications, requiring API key authentication and configurable model parameters.

• File 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 from seekdb to generate text embeddings with Google Vertex AI models, including required dependencies, authentication, and configuration parameters.

• File Path: 450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/400.jina-js.md

  • Description: Jina AI embedding models for semantic search and retrieval tasks, integrated with seekdb collections through the JinaEmbeddingFunction. Requires Jina API key authentication and supports custom model configurations.

• File 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 explains how to use Ollama's local embedding models with SeekDB by installing the necessary package and configuring the OllamaEmbeddingFunction. It covers dependencies, installation steps, and required API configurations for integration.

• File 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 covers the OpenAI embedding function for converting text into semantic vectors, including setup, authentication, and configuration options for the @seekdb/openai JavaScript package.

• File Path: 450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/700.qwen-js.md

  • Description: Qwen embedding models provide multilingual text embedding and ranking capabilities with long context support, integrated through seekdb's QwenEmbeddingFunction for generating and utilizing embeddings in collections.

• File 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: Sentence Transformer converts text into vector embeddings for semantic similarity tasks like search and clustering, using pre-trained models that run locally without API keys.

• File Path: 450.reference/900.sdk/20.seekdb-js/60.embedding-funcations-of-seekdb-js/700.embedding-function-wrapper-js/900.siliconflow-js.md

  • Description: SiliconFlow is a cloud platform hosting open-source foundation models, offering semantic embedding services for RAG, search, and recommendation workloads. The seekdb-js library provides SiliconFlowEmbeddingFunction to generate embeddings using models like BGE and Qwen series with configurable dimensions.

Tutorials

This category contains step-by-step tutorials for building AI applications with seekdb.

• File Path: 500.tutorials/100.create-ai-app-demo/100.build-kb-in-seekdb.md

  • Description: This tutorial demonstrates building a personal desktop knowledge base application using seekdb, featuring multi-project management, document processing, and AI-powered semantic search with local data storage. It covers environment setup, API configuration, and implementation of vector search and conversational Q&A using embedded seekdb for efficient, privacy-focused operations.

• File Path: 500.tutorials/100.create-ai-app-demo/300.build-multi-model-application-based-on-oceanbase.md

  • Description: This guide demonstrates building a cultural tourism assistant using OceanBase's multi-model integration, combining spatial data, vector search, and LLM Agent workflows for attraction recommendations and travel planning. It includes prerequisites, setup steps, and troubleshooting for implementing the application.

• File Path: 500.tutorials/100.create-ai-app-demo/400.build-image-search-app-in-seekdb.md

  • Description: This guide demonstrates how to build an image search application using seekdb's vector search technology, covering prerequisites, setup steps, and UI operations for converting and retrieving images as vectors.

• File Path: 500.tutorials/100.create-ai-app-demo/500.using-ten-framework-and-oceanbase-powermem-to-create-personalized-intelligent-voice-assistant.md

  • Description: This tutorial demonstrates building a personalized voice assistant using the TEN Framework and OceanBase PowerMem, integrating real-time multimodal capabilities with long-term memory for continuous, context-aware conversations. It covers setup, deployment, and the benefits of memory for personalization, emotional connection, and proactive service.

• File Path: 500.tutorials/100.create-ai-app-demo/600.build-a-rag-system-with-seekdb.md

  • Description: This tutorial demonstrates how to build a RAG application using seekdb, covering document import, hybrid-retrieval knowledge base creation, and launching a Streamlit-based query interface with multiple embedding options.

• File Path: 500.tutorials/200.scenarios/15.basic-sql-operations.md

  • Description: This document covers basic SQL operations in seekdb, including database and table creation, modification, and deletion, as well as index operations, data insertion, deletion, and updating.

• File Path: 500.tutorials/200.scenarios/30.experience-vector-search.md

  • Description: This documentation provides a comprehensive guide to using seekdb's vector search capabilities, including creating vector indexes, inserting data, and performing both exact and approximate searches. It covers practical SQL examples and comparisons between search methods for efficient retrieval of embedding vectors.

• File Path: 500.tutorials/200.scenarios/40.experience-full-text-indexing.md

  • Description: This tutorial demonstrates how to use seekdb's full-text indexing feature for efficient document retrieval, including dataset import, Boolean mode queries, and performance tuning. It also includes a performance comparison with MySQL highlighting seekdb's advantages in handling large datasets and complex queries.

• File Path: 500.tutorials/200.scenarios/50.experience-hybrid-search.md

  • Description: This tutorial demonstrates seekdb's hybrid search feature, which combines full-text keyword search and vector-based semantic search to deliver more accurate and comprehensive results. It covers implementation steps for pure vector search, pure full-text search, and hybrid search scenarios.

• File Path: 500.tutorials/200.scenarios/60.experience-ai-function.md

  • Description: This tutorial introduces seekdb's AI Function Service, demonstrating how to integrate AI capabilities directly into SQL operations for text generation, embedding, reranking, and building intelligent Q&A systems using core functions like AI_COMPLETE and AI_EMBED.

• File Path: 500.tutorials/200.scenarios/70.experience-hybrid-vector-index.md

  • Description: This tutorial demonstrates how to use seekdb's hybrid vector index for semantic retrieval by directly inserting and querying text without manual vector conversion. It covers index creation, data insertion, and retrieval methods, including advanced vector-based queries.

Demos

This category contains live demos showcasing seekdb capabilities.

• File Path: 600.demos/10.demo-overview.md

  • Description: Live demos showcase seekdb's AI-powered knowledge bases and visual search applications, featuring real-time semantic queries and multi-modal search capabilities. The platform enables vector search integration for both text-based Q&A systems and image search applications using SQL+AI.

---

Quick Reference

Common Topics by Use Case

Getting Started with seekdb

• seekdb Overview: 100.get-started/10.overview/10.seekdb-overview.md
• Quick Deploy (Docker): 100.get-started/100.use-seekdb-with-sql/10.deploy-seekdb-testing-environment.md
• Basic SQL Operations: 500.tutorials/200.scenarios/15.basic-sql-operations.md

Vector Search

• Vector Search Intro: 200.develop/600.search/300.vector-search/100.vector-search-intro.md
• Experience Vector Search: 500.tutorials/200.scenarios/30.experience-vector-search.md
• Vector Indexes: 200.develop/600.search/300.vector-search/200.vector-index/300.dense-vector-index/100.dense-vector-index-overview.md

Full-Text Search

• Experience Full-Text Indexing: 500.tutorials/200.scenarios/40.experience-full-text-indexing.md
• Full-Text Index Guide: 200.develop/200.design-database-schema/35.multi-model/300.char-and-text/300.full-text-index.md

Hybrid Search

• Experience Hybrid Search: 500.tutorials/200.scenarios/50.experience-hybrid-search.md
• Hybrid Search: 200.develop/600.search/500.hybrid-search.md

AI Functions

• Experience AI Functions: 500.tutorials/200.scenarios/60.experience-ai-function.md
• AI Function Reference: 200.develop/700.ai-function/200.text-generation-function.md

Python SDK

• pyseekdb Getting Started: 450.reference/900.sdk/10.pyseekdb-sdk/10.pyseekdb-sdk-get-started.md
• API Reference: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/10.api-overview.md

MCP Integration

• seekdb MCP Server: 300.integrations/600.mcp/200.seekdb-mcp-server.md
• Cursor Integration: 300.integrations/300.developer-tools/100.cursor.md
• Claude Code Integration: 300.integrations/300.developer-tools/700.claude-code.md

Framework Integrations

• LangChain: 300.integrations/100.frameworks/100.langchain.md
• LlamaIndex: 300.integrations/100.frameworks/200.llamaindex.md
• Dify: 300.integrations/400.workflows/400.dify.md

Management and Security

• Configuration Management: 400.guides/500.manage/100.configuration-management/100.configuration-management-introduction.md
• Security Overview: 400.guides/500.manage/300.security/100.security-overview.md
• OBShell Dashboard: 400.guides/1000.obshell/350.obshell-dashboard/100.dashboard-overview.md

Performance Testing

• VectorDBBench Test: 400.guides/1100.performance-test/100.vectordbbench-test-on-seekdb/100.ob-vector-search-bench-test.md
• Sysbench Test: 400.guides/1100.performance-test/200.sysbench-test-on-seekdb/100.use-sysbench-to-test-the-performance-of-seekdb.md