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.0.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 getting started guides, SDK/API examples, feature overviews, and tutorials for building AI applications with both embedded and server deployment modes.

---

Get Started

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

Overview

• File Path: 100.get-started/10.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 guide to using seekdb in client/server mode with SQL, covering deployment, database operations, and hybrid search optimization. It includes step-by-step instructions for setup, table creation, data insertion, and executing vector and full-text searches.

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, covering embedded database setup, note management, and semantic/hybrid search capabilities through AI chat interfaces.

• 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 using seekdb and Claude Code, including installing the seekdb plugin for accurate documentation retrieval and implementing a Python hybrid search application.

• 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 documentation, enabling accurate code generation and answers for seekdb-related development tasks. It includes a practical Python example demonstrating hybrid search implementation.

Use Seekdb With Sdk

• File Path: 100.get-started/50.use-seekdb-with-sdk/25.using-seekdb-in-python-sdk.md

  • Description: This guide demonstrates using OceanBase's pyseekdb Python SDK to deploy embedded seekdb, create databases and collections, insert data, perform hybrid searches, and clean up resources. It includes step-by-step instructions and code examples for implementing vector database operations 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.

Overview

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

  • Description: This documentation covers development with seekdb through Python SDKs and SQL interfaces, detailing connection methods, supported platforms, and multi-model data management capabilities.

Connect To Seekdb

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

  • Description: This document outlines methods for connecting to seekdb, including clients, drivers, ORM frameworks, and connection pools for various programming languages and tools.

• 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 provides prerequisites and step-by-step instructions for connecting to seekdb using a MySQL client, including command syntax and parameter descriptions. It also includes connection examples and troubleshooting guidance.

• 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, configuration, and execution of basic database operations including 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 queries. It includes prerequisites, setup instructions, and troubleshooting guidance.

• 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 with seekdb, covering basic database operations, transaction management, and connection pool configuration. It includes prerequisites, setup steps, and troubleshooting guidance for common issues.

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

  • Description: This document provides instructions for building a Spring Data JPA application that connects to seekdb, covering setup, configuration, and basic database operations such as 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 Hibernate, including prerequisites, setup steps, and troubleshooting common issues. It also includes a sample project for performing basic database operations.

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

  • Description: This document provides instructions for connecting to seekdb using the MyBatis framework, including steps for setting up the environment, configuring the connection, and running a sample project to perform database operations.

• 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, required prerequisites, and step-by-step instructions for setting up and running a sample Java application.

• 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 use mysqlclient to connect to seekdb and perform basic database operations including table creation, data insertion, and querying. It includes prerequisites, step-by-step setup instructions, and an overview of the project code structure.

• 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 sample program and step-by-step instructions for using PyMySQL to connect to seekdb and perform basic database operations including table creation, data insertion, queries, and deletion.

• 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 instructions for connecting to seekdb using the MySQL-connector-python driver, including prerequisites, installation steps, and a sample Python program for database operations. It also covers common error handling 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 guide for connecting to seekdb using SQLAlchemy, including steps for installation, configuration, and performing basic database operations such as creating tables, inserting, updating, and querying data.

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

  • Description: This document provides a step-by-step guide for connecting Django to seekdb, covering installation, configuration, model creation, and performing basic database operations including data insertion, updates, and queries.

• 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 a guide for connecting to seekdb using the peewee ORM library in Python, covering installation, configuration, and basic database operations including table creation, data insertion, updates, and queries. It also includes troubleshooting tips for common errors 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 table creation, data insertion, and queries. 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 instructions for building a Go application using the Go-SQL-Driver/MySQL driver to connect to seekdb and perform basic database operations, including creating tables, inserting data, and querying data. It includes prerequisites, setup steps, and a sample project download.

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

  • Description: This document provides instructions for building an application using GORM and seekdb, covering setup, connection configuration, and basic database operations like table creation and data queries. It includes a downloadable sample project with code examples.

• 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 step-by-step instructions for environment setup, connection configuration, 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 explains how to use the MySQLi PHP extension to connect to seekdb and perform basic database operations, including creating tables, inserting data, querying, and dropping tables. It includes prerequisites and step-by-step instructions for setup and verification.

• 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 the PDO driver to connect to seekdb from PHP and perform basic database operations including table creation, data insertion, querying, and deletion.

• 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 query execution. 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 to building a Rust application with SeaORM and seekdb, covering environment setup, database connection, entity definition, and CRUD operations implementation.

• 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 basic database operations including table creation, data insertion, and queries. It includes prerequisites, step-by-step configuration instructions, and troubleshooting guidance for common issues.

• 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 demonstrating how to connect to seekdb using mysql2 in Ruby, covering database creation, table operations, data insertion, and querying. It includes prerequisites, step-by-step instructions, and troubleshooting guidance.

• 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 and seekdb to perform database operations including table creation, data insertion, and querying. It includes prerequisites, installation instructions, sample code, and troubleshooting guidance.

• 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 concepts, parameter recommendations, and JDBC settings to optimize database access performance and stability. It includes practical examples and guidelines for managing connections effectively.

• 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. It includes prerequisites, 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 using C3P0 connection pool, MySQL Connector/J, and seekdb to perform basic database operations, including table creation, insertion, deletion, update, and query. It includes setup instructions, configuration details, and project code for implementation.

• 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 demonstrating how to use the Proxool connection pool with MySQL Connector/J and seekdb to perform basic database operations, including setup and configuration steps.

• 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 configuring a HikariCP connection pool with MySQL Connector/J to perform database operations on seekdb, including project setup, configuration, and execution.

• 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, setup instructions, and configuration details for the sample project.

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

  • Description: This document provides a guide for building a database application using Commons Pool, MySQL Connector/J, and seekdb, covering basic operations like table creation, data insertion, updating, deletion, and querying. It includes prerequisites, setup steps, and a downloadable sample project with configuration details.

• 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 Druid connection pool, MySQL Connector/J, and seekdb to perform basic database operations including table creation, insertion, updating, deletion, and querying. It includes prerequisites, setup instructions, and configuration details for the sample project.

• 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 optimizing OceanBase database connections, including recommended parameters for batch operations, timeouts, and performance enhancements.

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 various table types, update modes, and indexing strategies to support different data storage and query requirements.

• 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 including character set specification and read/write permissions.

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

  • Description: This document explains how to create a table in seekdb using SQL statements, covering prerequisites, table design, and constraints such as primary keys, foreign keys, and checks. It includes practical examples and best practices for defining columns and ensuring data integrity.

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

  • Description: This document describes seekdb's JSON data type implementation, which provides automatic validation, optimized storage format, and semi-structured encoding for efficient handling of JSON documents. It covers compliance with RFC 7159 standards and includes references to related JSON functions.

• 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 in seekdb, covering valid data types, syntax rules, and DDL operations for JSON columns including indexing and semi-structured encoding. It also details limitations, examples, and performance optimizations for JSON queries.

• 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 object structures.

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

  • Description: This document details the CAST function for converting between JSON and other data types in seekdb, including conversion rules for character sets, NULL values, and scalar types. It provides practical examples of converting strings to JSON and extracting values from JSON objects.

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

  • Description: This document explains how to enable and use JSON Partial Update in seekdb, which allows modifying specific JSON fields without rewriting entire documents. It covers enabling the feature via system variables, supported JSON expressions, storage considerations, and update granularity.

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

  • Description: Describes seekdb's semi-structured encoding feature for JSON columns, including enabling/disabling methods, frequent/sparse column classification, and performance benefits for JSON_VALUE queries.

• 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 and GEOMETRYCOLLECTION types.

• 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 geographic data, detailing projected and geographic SRS types along with the default SRID 0. It also describes how to query SRS information using system tables 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 in seekdb using CREATE TABLE and ALTER TABLE statements, including required SRID specifications and spatial index constraints.

• 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 spatial indexes in seekdb, covering required constraints like NOT NULL columns and SRID definitions, along with syntax examples for creating and dropping indexes.

• File Path: 200.develop/200.design-database-schema/35.multi-model/200.spatial/500.spatial-data-format.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 validity rules, and usage examples for various geometric objects.

• 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, maximum lengths, and trailing space handling. Covers syntax, character set specifications, and retrieval behaviors for both string types.

• 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 data types, tokenizers, and complex DML operations on indexed tables. It provides syntax rules, limitations, and practical examples for implementing efficient text search and retrieval.

• 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 memory usage, performance, and scalability. Includes decision flowcharts and parameter guidance for different data volumes and scenarios.

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 operations, constraint handling, and the INSERT OVERWRITE SELECT statement 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 a table using the UPDATE statement and other methods, including syntax, examples, and considerations for unique constraints. It also covers prerequisites like connection requirements and user privileges.

• 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 or full 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 index conflicts.

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

  • Description: This document explains how to generate large volumes of test data using a Shell script, stored procedure, or ODC, including prerequisites, step-by-step procedures, and verification methods.

• 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 INNER JOIN operation in SQL, covering syntax, usage with and without join conditions, and providing 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 with NULL values for non-matching columns.

• 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, usage examples, and how it returns all records from the left table with matching records from the right table or NULL values for non-matches.

• 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, examples, and comparisons with other join types. Covers both simple and complex queries with WHERE clause usage.

• 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, and includes sample tables and queries for illustration.

• 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. It covers their syntax, limitations, and provides practical SQL examples demonstrating their use and benefits.

• 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: Explains how to use arithmetic operators in SQL queries, providing examples of calculations like multiplication between columns in table joins.

• 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 for managing concurrent transactions. Provides practical examples and locking behavior details.

• 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: Explains the use of SELECT ... LOCK IN SHARE MODE to obtain shared locks that prevent write operations while allowing reads, including seekdb's implementation using write locks and performance considerations.

• 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, including practical examples with aggregation and data grouping.

• 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 through sample SQL queries and result sets.

• 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, extracting components, and performing date arithmetic with examples.

• 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 queries using NULL-related functions like IS NULL, NVL(), and IFNULL(). It includes practical SQL examples demonstrating the detection and transformation of NULL values into 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. It includes practical demonstrations for translating values and categorizing data based on date comparisons.

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

  • Description: Explains the use of UNION, UNION ALL, INTERSECT, and MINUS/EXCEPT operators in seekdb for combining and comparing query result sets.

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 using 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 covers AI MODEL permissions for managing AI models and endpoints, including CREATE, ALTER, and DROP permissions, and explains their relationship with AI function call permissions.

• File Path: 200.develop/400.llm/300.model-register-and-manage.md

  • Description: This documentation explains how to register and manage AI models and endpoints in seekdb using the DBMS_AI_SERVICE package and how to view information through database views.

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, detailing how unstructured data is converted into vectors, stored and indexed, then queried through hybrid search to generate prompts for LLM 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 data, including prerequisites, syntax, 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 Ollama, as well as online services via HTTP calls or SDKs. It covers both text and image embedding methods, providing code examples and prerequisites for implementation.

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 similarity calculations for efficient retrieval of unstructured data. It details capabilities for storing and querying both dense and sparse vectors using various distance metrics and SQL operators.

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

  • Description: This document explains how to perform vector search using SQL in seekdb, including creating vector columns and indexes, writing vector data, and executing similarity searches. It provides a practical example with sample data and queries.

• 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, vector column creation with specified dimensions, and index creation for hybrid search.

• 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 and inserting vector data with specified dimensions.

• File Path: 200.develop/600.search/300.vector-search/200.vector-index/100.vector-index-overview.md

  • Description: This document provides an overview of seekdb's supported vector index types, including dense indexes (HNSW and IVF series) and in-memory sparse indexes, along with their characteristics, memory requirements, and limitations.

• 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 describes the dense vector indexes available in seekdb, including memory-based HNSW series and disk-based IVF series indexes, which accelerate vector searches using distance functions like L2, inner product, and cosine distance.

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

  • Description: This document provides syntax and examples for creating, searching, and deleting HNSW, HNSW_SQ, and HNSW_BQ vector indexes in SeekDB, including parameter descriptions and best practices.

• 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 operations, retrieval syntax, and index maintenance. It covers the SINDI index type for efficient sparse vector handling with support for parameters like pruning and reranking.

• 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 covers the automatic performance optimization of IVF indexes in SeekDB, including cache warming and cleanup tasks, configuration of execution cycles, and monitoring through system views. It also provides instructions for canceling tasks and references for further maintenance.

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

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

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

  • Description: This document describes two vector similarity search methods in seekdb: exact nearest neighbor search using full-scan and approximate nearest neighbor search using vector indexes, including performance characteristics and usage examples.

• 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, and dimensional compression techniques for indexing. It provides practical solutions for vector column management and optimization.

• 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 supports both synchronous and asynchronous embedding modes. It covers feature support, prerequisites, creation syntax, and retrieval methods including text and vector searches.

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

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

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

  • Description: This document describes hybrid search in seekdb, which combines vector-based semantic search with full-text keyword search using integrated ranking for more accurate and comprehensive results. It includes usage examples, system functions, and implementation details for various search scenarios.

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

  • Description: This document describes the AI_RERANK function for reordering search results using semantic relevance models. It covers syntax, parameters, and implementation examples for optimizing search accuracy 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 the database, providing functions for text generation, embedding, reranking, and prompt management. It includes components for permissions, model management, and direct AI capability calls 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 like AI_COMPLETE, AI_EMBED, AI_RERANK, and AI_PROMPT. It includes syntax examples for granting and revoking this permission along with practical usage scenarios.

• 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 environment.

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 prerequisites and step-by-step instructions for loading documents, storing embeddings, and performing vector searches.

• 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 for document question answering applications. It provides prerequisites, setup steps, and a code example for building an AI assistant that queries text data.

• 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, enabling data import and similarity search features for building AI applications. It includes prerequisites, setup steps, and configuration details for developers.

Model Platforms

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

  • Description: This document provides integration instructions for using Jina AI's embedding models with seekdb's vector database capabilities to build multimodal search and RAG applications. It covers prerequisites, setup steps, and code examples for generating embeddings, storing vectors, and performing semantic searches.

• 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 setup and usage.

• 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 and step-by-step configuration for data insertion and retrieval.

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

  • Description: This document explains how to integrate seekdb's vector storage and search capabilities with Hugging Face's AI models, providing step-by-step instructions for storing embeddings and performing semantic searches. It includes prerequisites, environment setup, and code examples for data preparation and query execution.

• 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 operations.

• 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 multimodal AI models. It provides step-by-step instructions for generating embeddings, storing vector data, and performing semantic searches using sample code.

• 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's embedding API, providing code examples for generating embeddings, storing vectors, and performing semantic searches.

Developer Tools

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

  • Description: This document provides step-by-step instructions for integrating the seekdb MCP Server with the Cursor code editor, enabling SQL execution and FastAPI project creation through AI-assisted workflows. It covers prerequisites, server configuration, and practical examples for building backend applications.

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

  • Description: This guide explains how to integrate the seekdb MCP Server with the Cline AI coding assistant, covering setup, configuration, and building a sample FastAPI application for vector data storage and search 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 rapid backend application prototyping using large language models. It covers prerequisites, server setup, configuration steps, and includes a practical example using FastAPI.

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

  • Description: This document provides instructions for integrating the Trae IDE with the seekdb MCP Server to build backend applications. It covers prerequisites, server configuration, and creating a RESTful API project using FastAPI.

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

  • Description: This document explains how to integrate the seekdb MCP Server with Augment Code to enable large language models to execute SQL statements and interact with seekdb, including prerequisites and configuration steps.

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

  • Description: This document provides instructions for integrating the seekdb MCP Server with Claude Code to enable AI-assisted database interactions and rapid backend application development using FastAPI. It covers prerequisites, server configuration, and step-by-step guidance for creating database tables and RESTful APIs.

• 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 a backend application. It covers prerequisites, server configuration, and using FastAPI to create a RESTful API project with database interactions.

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 includes system requirements, database setup, and deployment instructions for both Docker Compose and MySQL-based installations.

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

  • Description: This guide demonstrates how to integrate seekdb vector search with n8n by building a Chat to seekdb workflow template, including prerequisites, deployment steps, and AI agent configuration.

Data Analyst

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

  • Description: This document explains how to integrate CamelAI with seekdb for natural language data queries, covering prerequisites, setup steps, and embedding storage for semantic search.

Mcp

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

  • Description: This guide explains 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.

• 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, AI functions, and persistent memory across sessions. Supports both embedded and client/server deployments for building knowledge bases, RAG applications, and data analysis workflows.

Plugin

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

  • Description: A plugin for Claude Code 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 the terminal workflow.

• 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 including code suggestions, troubleshooting, and technical Q&A. It features dual-mode document access with automatic fallback to local documentation when network connectivity is unavailable.

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.

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

  • Description: This document provides a comprehensive list of error codes and messages for obshell, along with descriptions and troubleshooting solutions for each error. It covers agent initialization, configuration, maintenance, and database-related issues encountered during obshell operations.

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

  • Description: This document describes obshell agent commands for starting, stopping, restarting, and upgrading the obshell service, including available options and usage examples.

• 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.

• 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, including options for seekdb operations and IPv6 usage.

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

  • Description: Web-based management interface for OceanBase's seekdb, providing resource management, performance monitoring, and instance administration capabilities through an integrated visual console.

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

  • Description: This document details the instance management page in the obshell Dashboard, covering instance information display, start/stop/restart operations, obshell upgrades, whitelist configuration, and major compaction initiation.

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

  • Description: This document explains how to access and use the Database Management page in the obshell Dashboard, covering viewing database details, creating, modifying, and deleting databases.

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

  • Description: This document provides instructions for managing users in the obshell Dashboard, including creating, locking, modifying permissions, changing passwords, and deleting users. It details the required parameters and procedures for each user management task.

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

  • Description: This document describes the Alarm Center feature in the obshell Dashboard, which enables centralized management of alert events, suppression rules, and alert rules for monitoring system stability. It covers filtering, muting, and configuring alerts with detailed instructions for each function.

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

  • Description: This documentation covers the performance monitoring dashboard for seekdb, which provides real-time metrics across performance, transactions, storage, and host metrics to identify bottlenecks and optimize resource usage. It includes instructions for configuring refresh rates, time ranges, and viewing detailed monitoring information.

• 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. It covers navigating the Parameter Management page, searching for parameters, and updating their values.

• 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, including filtering, sorting, and searching for specific 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 a comprehensive overview of all tasks, allowing users to filter, search, and manage tasks through operations like cancellation, rollback, retry, and log troubleshooting.

• 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 steps, configuration parameters, 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 describes two methods for importing data into seekdb: server-side import (recommended for production) using FILES() function with LOAD DATA or INSERT SELECT, and client-side import using LOAD DATA LOCAL INFILE when server cannot access files directly.

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 benchmarking seekdb performance using VectorDBBench, including prerequisites, test scenarios, and step-by-step procedures for conducting vector search tests.

• 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, plan, and performance results for the seekdb vector database using VectorDBBench, including qps, latency, and recall rate metrics for both 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 benchmark seekdb database performance, including environment setup, parameter optimization, and test execution steps for various workloads.

• 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 results for seekdb, including performance metrics for various operations across different thread counts and instance specifications.

• 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 instructions for running the TPC-H benchmark test on seekdb, including prerequisites, setup, and step-by-step guidance for data generation, query creation, and performance tuning.

• 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.0.1 using 10GB of data on a 4 vCPU/8GB memory instance, achieving a total query time of 12.16 seconds.

• 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 (Recall@10, NDCG@10) and performance (latency) across BM25, dense vector, and hybrid retrieval methods. It includes environment setup, test plans, and step-by-step execution instructions.

• 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 Linux operating systems, and necessary BIOS settings for optimal performance.

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

  • Description: This document outlines seekdb's two deployment modes: embedded mode for running as a library within applications on endpoints, IoT, and edge devices, and server mode for single-machine deployment in CI/CD and testing environments. It also details various deployment methods for each mode, including SDK usage, yum installation, container deployment, and OceanBase Desktop setup.

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

  • Description: This document outlines essential pre-deployment configurations for seekdb, covering user setup, disk planning, and system optimizations for both trial and production environments. It provides guidance on OS settings, resource allocation, and security adjustments to ensure stable and efficient database operation.

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

  • Description: Provides instructions for creating a regular user with sudo privileges and database directory ownership for enterprise SeekDB deployments. Covers user creation, password setup, and sudoers file 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 disks for seekdb servers, covering data, transaction log, and installation disk requirements for both personal and enterprise users. It includes detailed instructions for disk partitioning, mounting using LVM or fdisk tools, and post-mount verification steps.

• 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, and user processes. It provides specific configuration examples and instructions for verifying the changes.

• 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 through sysctl.conf configuration, including kernel, network, and memory parameter adjustments for enterprise environments. It covers both general modifications and ARM-specific deployment recommendations.

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

  • Description: Provides instructions for disabling the firewall and SELinux on Linux systems, including command sequences and configuration file modifications.

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

  • Description: This document covers embedded deployment of seekdb as a library within applications, detailing environment requirements and installation procedures for Python and pyseekdb SDK. It supports various endpoints including mobile, desktop, IoT, and edge devices.

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

  • Description: This document provides instructions for deploying seekdb using yum/rpm installation on supported RPM systems, including prerequisites, configuration steps, and service management through systemd. It covers both online and offline installation methods along with connection procedures and maintenance operations.

• 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 and macOS, including system requirements, dependency checks, and step-by-step installation procedures.

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 machine/instance control and system variables for SQL session behavior. It details their scopes, modification methods, and effective mechanisms.

• 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 parameters for seekdb, detailing data types and methods for viewing and modifying settings. It distinguishes between dynamically effective parameters and those requiring a restart.

• 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 see non-hidden and modified hidden parameters or the GV$OB_PARAMETERS view to access all parameters including hidden ones.

• 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: This document explains the system variables in seekdb, which are categorized as global and session variables. It details their scope, modification methods, and differences 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 the ob_query_timeout variable and handling boolean values.

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

  • Description: The recycle bin stores deleted databases, tables, and indexes, preserving them until manually purged or automatically removed. It supports limited operations like flashback restoration and purging, with specific limitations on object dependencies and operations.

• 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 use the SHOW RECYCLEBIN statement to view database objects that have been moved to the recycle bin after deletion, including details on object names, types, and timestamps.

• 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 deleted database objects, including detailed procedures and considerations for the purge operation.

• File Path: 400.guides/500.manage/200.high-availability/600.flashback-query.md

  • Description: This document explains how to perform record-level flashback queries in seekdb using the AS OF SNAPSHOT syntax and the undo_retention parameter to retrieve historical data versions. It covers configuration requirements, limitations, and practical examples for querying data within specified time ranges.

• 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 using the MySQL Authentication Protocol (MAPI), covering credential validation, access control, and user creation with IP-based restrictions.

• 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 by setting system variables to enforce requirements such as minimum length, character types, and username similarity checks. It includes practical examples for setting up and verifying these security policies.

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

  • Description: This document describes seekdb's login failure handling strategy, which locks user accounts after exceeding a configurable threshold of failed attempts to prevent malicious attacks. It details the relevant parameters for setting attempt limits and lockout durations, along with configuration examples and user unlocking procedures.

• 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 client allowlists.

• 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 user access control and system security.

• 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 database users, 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 at global, database, table, and column levels.

• 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. It provides examples of both successful and failed delegation scenarios.

• 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 and usage examples. 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, including system, database, table, and column-level permissions, using the GRANT statement with proper syntax examples.

• 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 usage scenarios for single and multiple assignments.

• 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 activate and manage user roles in sessions, including setting default roles at login and using statements like SET DEFAULT ROLE and SET ROLE to control permissions.

• 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 session-specific and default role settings, using various SQL commands and system views.

• 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 necessary prerequisites and providing multiple examples of the REVOKE statement syntax.

• 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 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 and the automatic revocation of the role from all users upon deletion.

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

  • Description: Explains how users can obtain privileges indirectly through role grants, including prerequisites and examples of granting roles to users or other roles. Covers viewing granted privileges and using the ADMIN OPTION for delegation.

• 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, including prerequisites and detailed procedures for checking global, database-level, and column-level permissions.

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

  • Description: This document provides an overview of user management and permission levels in seekdb, covering global, database, and object permissions. It explains permission delegation, roles, indirect permissions, and the permission checking process for SQL operations.

• 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 global, database, table, and column levels, including prerequisites and considerations for the operation. It provides syntax examples for each scenario using the REVOKE statement.

• 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 the database using the ALTER USER command, including prerequisite privileges and verification steps.

• 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, limitations, and step-by-step instructions. It also covers the retention of user-created objects and provides an example deletion command.

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

  • Description: This document describes seekdb's whitelist-based network security access control using the ob_tcp_invited_nodes system variable. It covers configuration methods including exact IP matching, wildcard patterns, and CIDR notation for client access management.

• 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 for enhanced data protection.

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

  • Description: This document provides instructions for enabling transmission encryption in seekdb, covering configuration steps 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, system views, character sets, collations, functions, partitions, storage engine, and optimizer, while noting specific unsupported features.

Release Notes

• File Path: 450.reference/1300.release-notes/1000.v1.0.0.md

  • Description: OceanBase seekdb is 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. It supports embedded and client/server deployments with full MySQL compatibility and integrates with popular AI frameworks.

• File Path: 450.reference/1300.release-notes/999.V1.0.1.md

  • Description: This release introduces vector index enhancements including new distance metrics and increased search limits, while addressing numerous bugs in vector, semantic, and full-text search indexes along with general system improvements.

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: The RoaringBitmap data type in seekdb is an efficient compressed format 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 arrays and supports 64-bit integers while providing superior compression and performance over traditional bitmaps.

• 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 in OLAP scenarios. 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 examples, supported data types, and considerations such as the inability to set default values.

• 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: Describes the map data type in seekdb, which stores unordered key-value pairs for configuration, attributes, and product data. Covers supported key/value types, DDL/DML operations, and current limitations like unsupported comparisons and aggregations.

• 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: Explains how to create map columns using the CREATE TABLE statement, including syntax examples and considerations such as the inability to set default values. Covers nested data types and provides practical examples for writing and querying map data.

• 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, covering integer, fixed-point, floating-point, and bit-value types along with their precision specifications and the ZEROFILL attribute 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: Describes integer data types in seekdb, including storage lengths, value ranges, and usage details for TINYINT, SMALLINT, MEDIUMINT, INT, BIGINT, and SERIAL types.

• 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, supporting synonyms like DECIMAL, NUMERIC, and FIXED. They allow unsigned and zerofill attributes with a maximum precision of 65 digits and scale of 30.

• 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 dependent on type length, precision, and scale. The documentation covers FLOAT and DOUBLE types, their storage characteristics, syntax options, 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 a specified length from 1 to 64 bits. Values are inserted using b'value' notation and automatically left-padded with zeros when shorter than the defined length.

• 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 DATE, TIME, DATETIME, TIMESTAMP, and YEAR, detailing their formats, value ranges, and scale attributes.

• 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 time zone handling and automatic initialization capabilities.

• 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 time intervals, supporting values from -838:59:59 to 838:59:59 with optional microsecond precision. It accepts string or number inputs and displays 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 data type represents years in YYYY format from 1901 to 2155, plus 0000, and supports various numeric and string input formats with automatic conversion rules.

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

• 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 for storing binary byte strings, detailing their syntax, length specifications, storage behavior, and comparison operations. It explains how these types differ from their CHAR and VARCHAR counterparts in handling binary data.

• 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: Provides an overview of seekdb's BLOB and TEXT data types, detailing their storage capacities, character sets, and key differences from VARBINARY and 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 in four variants with different maximum lengths, treating values as byte strings for comparison. It handles data truncation with warnings or errors depending on SQL 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 details the TEXT data type and its variants (TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT) for storing text data, covering their maximum lengths, storage requirements, character set specifications, and behavior during data insertion.

• 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, functions as a special LOB type, and can serve as a primary key or index column with specific storage and length limitations. It supports various partitioning methods and has constraints regarding out-of-line storage when exceeding LOB thresholds.

• 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 is a string object that stores one value from a predefined list of string literals, with internal integer representation for storage efficiency and readable string output in queries. It supports up to 65,535 elements and the UTF8MB4 character set with optional character set and collation specifications.

• 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 limits, 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 provides an overview of JSON data types in seekdb, covering their RFC 7159 compliance, storage of semi-structured data, automatic validation, and efficient binary format conversion. It also references JSON functions and detailed 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 of JSON values and provides guidelines for creating and managing JSON columns in seekdb, including syntax examples, limitations, and performance optimizations through semi-structured encoding.

• 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 extracting data and functions for updating JSON documents.

• 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 describes the JSON data type conversion rules for the CAST function, including bidirectional conversions between JSON and other data types with specific handling for 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 provides an overview of the spatial data types supported by seekdb's GIS feature, including basic types like POINT and POLYGON, their multi-collection counterparts, and the versatile GEOMETRY and GEOMETRYCOLLECTION types.

• 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 describes 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 CREATE TABLE and ALTER TABLE statements, including syntax examples and 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, SRID definitions, and the use of stored generated columns, along with syntax examples for creating and dropping indexes.

• 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), covering their syntax, geometric object types, 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 inputs like constants, column references, operators, and functions that return an output result. It describes how expressions are classified and used in various SQL clauses.

• 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 database 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 data type conversion rules during expression evaluation in seekdb, covering both implicit and explicit conversion methods. It details conversion behaviors for comparison operators and provides examples of type downgrading scenarios.

• 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 provides instructions for viewing available sets and specifying non-default character sets for server communication.

• 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 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 using CREATE DATABASE and ALTER DATABASE statements, including syntax examples and selection rules.

• 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 change the default character set and collation for a table using CREATE TABLE and ALTER TABLE statements, including syntax 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 specify and manage column-level character sets and collations for character-based data types in SQL, detailing the syntax for CREATE TABLE and ALTER TABLE statements. It also covers the rules for automatic selection and the conditions required 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. It covers syntax for explicit specification using _charset_name and COLLATE clauses, along with rules for determining default character sets and collations when not 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 relevant system variables and SQL statements for configuration. It covers the conversion of statements and results between client and server character sets.

• 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 string, numeric, date/time, bit, boolean, and NULL values used in functions, SQL statements, expressions, and conditions.

• 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 usage examples.

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

  • Description: Explains decimal and hexadecimal numeric values, covering exact and approximate decimal types, syntax rules, and conversion examples.

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

  • Description: This document details the accepted formats for date, time, datetime, and timestamp literals in seekdb, including string and numeric forms with and without separators. It also covers the interpretation of two-digit years and fractional seconds.

• 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 SQL, including valid formats and how they are treated as binary strings or integers. It provides examples of defining bit values and demonstrates their behavior in queries and variable assignments.

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

  • Description: This document covers Boolean values and their constants TRUE and FALSE, which evaluate to 1 and 0 respectively, with case-insensitive constant names.

• 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 handled in ordering and data import/export operations.

• 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 using backticks and character set requirements. It also explains how to qualify identifiers with database and table names using proper syntax.

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

  • Description: This document covers user-defined variables in SQL, including syntax, assignment, data types, and session-specific behavior, along with compatibility considerations and limitations for various statement types.

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

  • Description: This document explains how to add comments to SQL statements using line and block comment syntax, and how to add descriptive comments to database objects using the COMMENT clause in DDL statements.

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

  • Description: This document provides an overview of operators, including their syntax and classifications into unary and binary types. It lists the specific operator categories supported, such as 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: Describes the BINARY conversion operator in seekdb, which converts expressions to binary strings for case-sensitive and whitespace-aware string comparisons. Covers syntax, usage examples, and equivalent conversion methods.

• File Path: 450.reference/200.sql/100.sql-syntax/200.operator/1100.case-conditional-operator.md

  • Description: This document explains the CASE conditional operator in SQL, which provides IF-THEN-ELSE logic without subprograms. It covers both 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: Lists operator precedence for arithmetic, bitwise, comparison, logical, date/time, string, and collation operators in seekdb, including special cases for assignment 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 modulo functions, along with their syntax and result calculation rules.

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

  • Description: This document describes seekdb's bitwise operators, including AND, OR, NOT, XOR, and shift operations, which operate on unsigned 64-bit integers. It provides syntax examples and explanations for each operator's functionality.

• 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. It covers standard operators like =, !=, >, <, as well as IN, BETWEEN, LIKE, and IS NULL operators.

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

  • Description: This document describes the logical operators available in seekdb, including NOT, AND, OR, and XOR, detailing their syntax, usage, and behavior with examples. It also notes implementation specifics and limitations, such as support for array data types with the ANY operator.

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

  • Description: Explains seekdb's assignment operators, including the := operator for variable assignment in any SQL statement and the = operator for assignments in SET and UPDATE statements.

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

  • Description: This document covers seekdb's date and time operators, which are equivalent to DATE_ADD and DATE_SUB functions for performing addition and subtraction operations on dates and times.

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

  • Description: This document describes seekdb's character concatenation operators, specifically the || operator whose behavior depends on the sql_mode setting for string concatenation or logical OR operations.

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

  • Description: This documentation provides an overview of seekdb's built-in functions, including single-row, aggregate, analytic, encryption, and specialized functions for JSON, XML, spatial data, and other data types. It covers function categories, behaviors, and specific implementation details for the database system.

• 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 the first value from a column within each group, allowing queries with non-aggregated columns to execute successfully.

• 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 in network byte order. Returns NULL for invalid input parameters.

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

  • Description: Converts a numeric IPv4 address in network byte order to a dotted-quad string representation. Returns NULL for invalid input parameters.

• 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 address format.

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

  • Description: Converts numeric IPv6 or IPv4 addresses to binary strings, returning platform-independent lowercase representations with a maximum length of 39 characters. Returns NULL for invalid addresses.

• 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 ::ipv4_address format 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 its string representation, with optional swapping of time parts. This function returns a formatted UUID string or NULL if the input is invalid.

• 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 consider 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 versions.

• 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, covering syntax, parameters, search modes, and usage in filtering, relevance projection, and result sorting.

• 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 fixed value, column reference, or expression. This ensures complete output by handling missing data in query results.

• 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 reorder time components for improved index efficiency. Returns a VARBINARY(16) value or NULL if the input is NULL.

• 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, returning 0 if uninterrupted or 1 if interrupted when executed alone. When part of a query, interruption results 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 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 that guarantees uniqueness under specific server configuration and usage conditions. The identifier is constructed using server ID, startup time, and an incrementing variable.

• 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 exclusively used in INSERT ... ON DUPLICATE KEY UPDATE statements to reference column values from the INSERT portion during the UPDATE operation. In all other contexts, it returns NULL.

• 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 value exists.

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

  • Description: Returns a specified constant value and names the resulting column in the output. Primarily used to define column names for constant values in result sets.

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

  • Description: Adds a specified interval or number of days to a date. The function supports both interval-based addition and direct day addition syntax.

• 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 dates and times using customizable format specifiers, including options for day, month, year, time, and various date components.

• 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. Accepts DATE, TIME, or DATETIME inputs and returns the calculated result.

• 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 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 date part as an integer, supporting various time units including WEEK and YEAR_MONTH. Multiple parts are concatenated when specified together.

• 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. This function calculates the corresponding calendar date for a given number of days.

• 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 timezone-unaware DATETIME or as a formatted string when a format parameter 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 standard format strings for date, time, datetime, or timestamp values based on specified regional conventions. Used with DATE_FORMAT and STR_TO_DATE functions to format or parse date/time values.

• 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 conversion from source time zone to UTC.

• 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, returning it as a numeric integer. This function handles both standard 24-hour time and extended hour values beyond 24 hours.

• 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. This function is a synonym for NOW() and accepts a precision 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/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.

• 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 or results exceeding the year 9999. Handles day values beyond 366 by incrementing the year accordingly.

• 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: Extracts microseconds from time or datetime expressions, returning the microsecond component as an integer value.

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

  • Description: Extracts the minute component from a time value, returning an integer between 0 and 59.

• 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 from a given date as a numeric value.

• 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 formatted as YYYYMM or YYMM. 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 seconds value into a time format, producing results within 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 a datetime or time expression and another time expression, returning the result in the same format as the first input.

• 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 configurable fractional second precision. Accepts an optional parameter (0-6) to specify decimal places in the time output.

• 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 the time component. 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 and returns it as a TIME 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 specified format strings, supporting only hour/minute/second/microsecond specifiers. Handles hours exceeding 23 by producing modulo 12 values for most hour formats except %H and %k.

• 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 time values to their equivalent total 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 1970-01-01 00:00:00.000000, 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: Returns the time interval between two datetime values as a TIME 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: This function converts expressions to datetime values or adds time intervals to datetime expressions, 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 arithmetic by adding or subtracting specified time intervals from a timestamp. Supports various time units including days, weeks, months, and years.

• 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 interval between two date and time values in specified units. Supports various time units compatible with 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 0000-01-01 for a given date value, accepting various date formats as input.

• 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 for NULL inputs. It accepts both numeric and date string expressions as valid input parameters.

• 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. When called without parameters, returns the current Unix timestamp.

• 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 handles timezone considerations and accepts a microsecond count as its input parameter.

• 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 the YYYY-MM-DD format. The function can be used in arithmetic operations to calculate future or past dates.

• 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 fractional seconds precision parameter.

• 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 time in YYYY-MM-DD HH:MM:SS format with optional fractional seconds precision. Accepts an optional parameter to specify seconds precision 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/5500.week.md

  • Description: Returns the week number of a given date within its year, with an optional mode parameter to control week numbering logic and starting day 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, where Monday is 0 and Sunday is 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 define week numbering logic. The mode determines the first day of the week and the criteria for the first week of the year.

• 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 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/6100.addtime.md

  • Description: Adds a time expression to a time or datetime value and returns the result. Supports microsecond precision in time 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 weekday name 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 an optional precision parameter for microseconds. 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 specified time intervals to date/time values, supporting various units from microseconds to years. Handles both independent and combined interval types with flexible formatting.

• 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.

• 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 each bit in a value as either an "on" or "off" string, with bits checked from least to most significant. The output uses a separator between values and allows specifying the number of bits to process.

• 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), and 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/2000.field.md

  • Description: Returns the index position of a value within a list of parameters, starting from 1. Handles string, numeric, and NULL comparisons, returning 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: Returns the position of a string within a comma-separated list, starting from 1, or 0 if not found. The function requires non-comma strings and returns NULL for NULL inputs.

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

  • Description: Formats numbers with thousand separators and specified decimal places, returning the result as a string. Handles rounding and omits decimal components when zero decimal places are specified.

• 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 input converted to 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, returning the modified string. Handles edge cases including out-of-range positions, negative lengths, and 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 two-argument LOCATE() function with reversed parameters.

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

  • Description: Converts an integer value to its corresponding IP address, returning NULL for values exceeding 4294967295 or NULL inputs. The function calculates each octet using modular arithmetic operations on the input value.

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

  • Description: Converts IP addresses to integers using a specific mathematical formula based on the four octets of the address.

• 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, returning the first match for a specified key or NULL if not 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 values to their 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. This multibyte-safe function returns NULL if either the string or length parameter is NULL.

• 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: This document describes the LOCATE function, which returns the position of a substring within a string, optionally starting from a specified position, and 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 to a specified length using a padding string, 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 based on which bits are set in the input value, with each string corresponding to a specific bit position. The function maps binary bit positions to string arguments, returning only those strings whose corresponding bit is set to 1.

• 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 by concatenating multiple strings with a specified separator, replacing any NULL values with a designated replacement value 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 optional length. Returns NULL for NULL parameters 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/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() that returns the byte length of a string. This function calculates the number of bytes in a given string input.

• 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 multibyte characters by calculating their composite byte values. For single-byte characters, it returns the same value as the ASCII() function.

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

  • Description: This function returns the number of characters in a string and is a synonym for CHAR_LENGTH. It provides character-based length measurements rather than byte counts.

• 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 both binary and non-binary strings, converting numeric parameters to string form.

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

  • Description: Escapes strings for safe use in SQL statements by adding necessary backslashes and enclosing in single quotes, while handling NULL values by returning the unquoted 'NULL' string.

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

  • Description: This document describes the REGEXP 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, with optional parameters for search position, occurrence, return type, and matching rules. Returns 0 if no match is found or NULL for NULL inputs.

• 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, with optional case sensitivity and newline handling parameters. Returns 1 for a match, 0 for no match, or NULL for null inputs.

• 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 count, and matching 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 substrings matching a regular expression pattern from a string, supporting multi-byte characters and optional parameters for position, occurrence, and match rules. 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, with NULL handling for invalid 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 for replacing substrings in strings, including its syntax, parameters, case sensitivity, and NULL handling behavior. It provides usage examples and notes on MySQL compatibility differences between versions.

• 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 multibyte characters and numeric inputs.

• 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, 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 match, 0 for no match, or NULL 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 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/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 N and outputs a string with N space characters.

• 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 specified delimiter and returns the substring at a given 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 for identical strings, -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: Extracts a substring from a string starting at a specified position, with optional length. Handles negative positions and returns empty strings for invalid parameters.

• 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 the occurrence count of a delimiter, supporting both positive and negative count values. Returns NULL for NULL parameters and empty strings for empty inputs or zero count.

• 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, serving as a synonym for the UPPER() function.

• 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 invalid inputs. Includes usage notes for binary columns and numeric parameters.

• 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. This function accepts a string input and returns the uppercase version.

• 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. The function supports UTF-8 character sets and returns NULL for NULL inputs.

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

  • Description: Returns the weight string for comparison and sorting values, primarily used for internal debugging and testing of collations. Supports optional AS and LEVEL clauses to control string conversion and weight level output.

• 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 its base-64 encoded form, enabling encoding operations for string data.

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

  • Description: Decodes a base-64 encoded string and returns it as a binary string, typically used to reverse the TO_BASE64() encoding process.

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

  • Description: Converts a string to a phonetic code representing its pronunciation, enabling fuzzy matching and queries for similar-sounding words in databases.

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

  • Description: Converts expressions between various data types including CHAR, DATE, DATETIME, DECIMAL, JSON, and numeric types, with support for type-specific parameters and conversion rules.

• 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 SCN (System Change Number) to a timestamp of the DATETIME type, as demonstrated with the oceanbase.gv$ob_log_stat view.

• 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), returning a UINT64_T value.

• 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 numeric representations. Supports various format elements including decimal separators, thousand separators, currency symbols, and sign indicators.

• 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 elements including eras, time zones, and localized formats.

• 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 transforms expressions between character sets or data types. It supports two syntax forms: converting character encodings with USING or casting to specific types equivalent to CAST.

• 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 parses trace IDs to reveal the originating server's IP address and port number for SQL requests, with information also 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 and handles NULL values and type conversions. It includes the function declaration, behavior details, and an example output.

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

  • Description: Computes the cosine of a given radian value. Returns the trigonometric cosine function result for the input angle.

• 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 of its purpose, 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 the cyclic redundancy check value for a given string expression, returning a 32-bit unsigned integer. Returns NULL if the input expression 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 in radians to degrees. This function is used for trigonometric calculations in SQL.

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

  • Description: This document describes the EXP function, which returns the value of the natural logarithm base e raised to the power of a given input. 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/1500.floor.md

  • Description: Returns the largest integer less than or equal to a given expression, handling numeric inputs, boolean comparisons, and null values. Converts results to BIGINT type.

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

  • Description: This function generates a specified number of empty rows for use in table functions, enabling data generation when combined with expressions like constants, variables, or other functions. It supports parallel operations but operates with a degree of parallelism of one when generating rows.

• 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, producing NULL and warnings for arguments less than or equal to zero. Equivalent to the LOG function.

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

  • Description: This document describes the LOG function, which calculates either the natural logarithm of a number or a logarithm with a specified base. It details the function's syntax, behavior with different inputs, and includes usage examples.

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

  • Description: Computes the base-10 logarithm of a given number, returning NULL for negative inputs.

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

  • Description: Returns the exponent of a value with base 2. Handles 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]. The function calculates the angle whose cosine equals the given input value.

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

  • Description: The MOD function calculates the remainder after division of two numbers, working with decimal values and returning NULL for NULL inputs or division by zero. It is equivalent to the % and MOD operators.

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

  • Description: Performs negation operations on numeric values and boolean comparisons, returning the negated result of the operand or boolean expression.

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

  • Description: This function generates floating-point numbers following a normal distribution using specified mean and standard deviation parameters. It requires constant scalar values for mean and stddev and typically uses RANDOM() for value generation.

• 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) and demonstrates its usage in SQL queries.

• 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. It serves as an alias for the POW function and returns NULL if either input is NULL.

• 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, with π radians equaling 180 degrees. Returns the radian value of input X.

• 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. Supports various SQL clauses including SELECT, WHERE, and ORDER BY for randomization 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 can be used for generating random numbers or as input for distribution functions.

• 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 length and generation parameters.

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

  • Description: Computes the inverse sine of a value, returning 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: Returns a value rounded to the nearest integer or specified decimal precision, using different rounding rules for exact and approximate values. Supports both positive and negative decimal place parameters.

• 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 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 a given radian value X.

• 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 number. Returns NULL for negative inputs.

• 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. This function is used for trigonometric calculations with angle inputs.

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

  • Description: This document describes the TRUNCATE function, which returns a number truncated to a specified number of decimal places, including handling of zero and negative precision 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 and provides usage examples.

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

  • Description: Returns uniformly distributed integers or floats between specified minimum and maximum values. The output type depends on whether both 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 quadrant of the result using both parameters' signs. This function is equivalent to ATAN(X,Y).

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

  • Description: Returns an integer following the Zipf distribution within a specified range [0, N), using a characteristic exponent s to control skewness and a generator function for randomness.

• 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. Returns 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 handling NULL inputs appropriately. The function automatically converts numeric strings and returns 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 the input value, functioning as an alias for CEIL(). Handles numeric inputs, NULL values, and automatically converts numeric strings to numbers.

• 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. Returns a string representation of the converted number in the target base.

• 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 position index where a value falls within an ordered sequence of intervals. Handles NULL values by treating them as satisfied conditions and returns the appropriate interval index based on sequential comparisons.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/200.single-row-functions/500.comparison-functions/300.isnull.md

  • Description: Returns 1 if the expression is NULL and 0 otherwise, providing a reliable method for null checking in SQL operations.

• 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 causing the result to be NULL. 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, including two declaration formats with examples for value comparison and conditional logic.

• 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. It covers the function's syntax, return behavior, and includes 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 types including string, float, or integer.

• 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. This function 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: Provides Oracle-compatible conditional value mapping functionality equivalent to DECODE(), returning specified values based on input condition matches.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/100.approx-count-distinct-agg.md

  • Description: This function calculates an approximate count of distinct values for a given expression, useful for determining column selectivity. It returns a single approximate value rather than an exact count.

• 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 smallest value from a specified data column, supporting both string and numeric parameters with optional DISTINCT filtering.

• 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 a given expression, returning NULL when no matching rows exist. This function serves as an alias for STDDEV_POP().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1200.stfdev-agg.md

  • Description: Computes the population standard deviation of an expression, returning NULL if no matching rows exist. This function is an alias for STDDEV_POP().

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1300.srddev-pop-agg.md

  • Description: Computes the population standard deviation of a given expression, returning NULL when no matching rows are found.

• 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(). Returns NULL when no matching rows exist.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1500.sum-agg.md

  • Description: This document describes the SUM function, which returns the total of expression values and supports DISTINCT operations for unique value summation. It covers syntax, behavior with empty sets, and provides usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/1600.var-pop-agg.md

  • Description: Calculates 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: Computes 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 an 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 value averaging and returns null when no matching rows are found.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/300.bit-and-agg.md

  • Description: This function returns the bitwise AND of all bits in an expression, with result type determined by whether parameters are evaluated as binary strings or numbers. It 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 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 binary string or numeric evaluation depending on argument type. Returns a neutral value (all bits 0) when no matching rows are found.

• 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 result set, with options for counting distinct values or all rows including NULLs.

• 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 values and grouping operations for aggregated string results.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/300.aggregate-function/800.grouping-agg.md

  • Description: Explains the GROUPING function for identifying super-aggregation rows generated by WITH ROLLUP in GROUP BY clauses. Provides syntax, examples, and usage scenarios 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 keywords.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/100.approx-count_distinct.md

  • Description: Approximates the number of distinct values in an expression, providing faster performance than exact count operations 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 counting.

• 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 window partitions, returning values between 0 and 1 based on row position relative to sorted partition data.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/1500.dense-rank.md

  • Description: This document describes the DENSE_RANK window function, which calculates continuous integer ranks for rows based on specified ordering. It includes syntax, usage explanation, and practical SQL examples demonstrating how the function handles tied 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. Supports optional NULL handling and analytic partitioning.

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

  • Description: Computes the average of expression values, ignoring NULLs, with optional DISTINCT filtering. Supports analytic window functions for partitioned calculations.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/2700.lag.md

  • Description: The LAG window function returns the value of a specified expression from a previous row in the result set, with configurable offset, default value, and null handling options. It provides an efficient way to access prior row data compared to self-joins.

• 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 using analytic functions. Supports optional NULL handling with RESPECT NULLS or IGNORE NULLS clauses.

• 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 column, allowing access to values from rows following the current row. It supports optional parameters including offset, default values, and null handling within partitioned and ordered datasets.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/300.bit-and.md

  • Description: Returns the bitwise AND of all bits in an expression, handling binary strings and numerical values differently. NULL values do not affect the result unless all values are NULL, in which case it returns a neutral value with all bits set to 1.

• 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. Can be used with DISTINCT/ALL keywords and analytic clauses for window function operations.

• 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. This analytic function can operate over distinct or all values with identical results for both options.

• 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, allowing specification of direction (first or last) and null handling. The function requires a positive integer for n and returns null if n exceeds the window size.

• 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, returning a value consistent with the input column's type. The function ignores NULL values and does not support DATETIME types.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3500.rank.md

  • Description: The RANK function assigns a sequential rank to rows within partitions, skipping subsequent ranks when ties occur. It operates over specified partitions and ordering criteria in SQL window functions.

• 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 is useful for ranking and ordering query results.

• 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, which is an alias for 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 a given expression, functioning as an alias for STDDEV_POP. The function returns NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/3900.stddev-pop.md

  • Description: Returns the standard deviation of an expression across matched rows, returning NULL if no rows are matched. Supports analytic operations with an OVER clause for window function 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: Returns the sample standard deviation of an expression, calculated as the square root of VAR_SAMP. Returns NULL when no rows match the specified 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, including optional distinct values, and supports analytic functions for partitioned calculations. Returns NULL if no rows match the condition.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/400.analysis-functions/4200.var-pop.md

  • Description: Computes the population variance of a given expression, returning NULL when 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. This window function operates over a specified window clause for statistical analysis.

• 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, functioning 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: Returns the 128-bit MD5 checksum of a string as a 32-character hexadecimal value, returning NULL for NULL inputs.

• 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 the original data.

• 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 length len, where len can be any value between 1 and 1024.

• 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 the result 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 of a given string as a 40-character hexadecimal value, equivalent to the SHA() function.

• 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 (SHA-224, SHA-256, SHA-384, or SHA-512) for input strings using specified bit lengths.

• 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 password strength for a given string, returning an integer score from 0 (weak) to 100 (strong). Password evaluation uses system variables that can be viewed with specific SHOW VARIABLES commands.

• 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. This document provides its declaration, description, and usage examples.

• 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 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, which can be decompressed using the UNCOMPRESS function.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/400.decode.md

  • Description: This document describes the DECODE function, which decrypts an encrypted string using a specified password to return 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 a specified key or key file. Requires SSL support and returns NULL on errors or original strings if not encrypted.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/500.encryption-and-compression-functions/600.des-encrypt.md

  • Description: Encrypts a string using DES encryption with optional key specification, returning a binary string. Requires SSL configuration and uses a predefined key file when no key is provided.

• 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 specified passphrase, returning a binary string 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 with a specified salt. Returns a binary string or NULL if the system lacks crypt() support 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 multiple times to measure performance, returning 0 upon completion or NULL for invalid arguments. Reports client-side execution time rather than server CPU time.

• 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, or 0 if no transaction is active.

• 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 using utf8mb4 character encoding. This function is a synonym for USER().

• 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 using utf8mb4 character encoding.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/1600.version.md

  • Description: This document describes the VERSION() function, which returns the current seekdb version number compatible with MySQL in 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. The function supports various character sets, including utf8mb4 and binary.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/300.coercibility.md

  • Description: This document describes the COERCIBILITY function, which returns the collation priority value of a string expression for resolving collation conflicts in multibyte character sorting operations. It includes the function syntax, priority value explanations, conflict resolution rules, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/400.collation-info.md

  • Description: Returns the collation of a specified string. Supports viewing available collations through the SHOW COLLATION statement.

• 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 connection.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/600.information-functions/550.current-role.md

  • Description: Returns the currently active role for the user session, indicating which permissions are in effect. Shows "NONE" if no role is currently 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, or 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 a 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 from the last inserted row in the current session, specifically 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 compatibility with MySQL and key differences in handling auto-increment values 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. Used for generating properly formatted JSON string values in SQL.

• 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, 0 if not, and NULL for invalid parameters or paths.

• 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, with options to check for any or all paths.

• 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 matched values or NULL if parameters are invalid or paths cannot be located.

• 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 keys from the top-level values of 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 comparison of arrays, objects, and scalar values without type conversion.

• 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 single or multiple matches with pattern matching similar to the LIKE operator. Handles escape characters and returns NULL if no match is found or parameters are invalid.

• 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 values from JSON documents at specified paths, with optional type conversion and configurable error handling for empty results or conversion issues.

• 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. Supports scalar values and JSON documents as input.

• 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 specified values to JSON arrays at given paths, automatically wrapping non-array elements when necessary. This function returns the modified JSON document or NULL for invalid inputs.

• 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 specified values to arrays within JSON documents and returns the modified result. This function handles path-value pairs and automatically wraps non-array elements when necessary.

• 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 JSON arrays, 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. The function 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 by prioritizing later values and removing null-valued members. Returns the combined result or raises an error for invalid inputs.

• 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, merging objects, and wrapping scalars in arrays. Returns NULL if any argument is NULL or invalid.

• 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 elements from a JSON document and returns the modified result. The function handles invalid paths by ignoring non-existent elements and returns NULL if any parameter is NULL.

• 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 ones. 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 JSON. Handles both existing and new elements while validating input parameters and path expressions.

• 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, element count for arrays, and member count for 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 for valid JSON objects, arrays, or scalars, returning NULL for NULL inputs and errors for invalid JSON values.

• 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: This function validates whether an input value is properly formatted JSON, returning 1 for valid JSON and 0 for invalid JSON. It 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: Converts JSON data into relational tables by extracting values through specified paths, enabling structured querying and integration with SQL operations. Supports nested structures and error handling for robust data transformation.

• 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: Returns the number of binary bytes required to store a JSON document, accepting either JSON values or parseable strings as input.

• 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, converting each row into an array element. 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: Aggregates key-value pairs into a JSON object, retaining the last value for duplicate keys. Returns NULL if no rows are processed or if errors occur.

• 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 requiring both parameters to be valid JSON.

• 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, along with specific failure details if validation fails.

• 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 creation, data extraction, schema validation, and document merging.

• 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 the EXTRACTVALUE function for retrieving text nodes and the UPDATEXML function 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 concatenated text or 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: This function updates XML content by replacing nodes specified with an XPath expression. It returns the modified XML as a LONGTEXT value.

• 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 the seekdb system 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 converting invalid polygons into valid geometric forms.

• 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 strings for approximate location representation, with optional precision control. Supports points and polygons through binary spatial division encoding.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/800.spatial-functions/150.create-a-geometry-function.md

  • Description: This document describes functions for creating geometry values from Well-Known Text (WKT), Well-Known Binary (WKB), and coordinate inputs, including ST_GeomFromText, ST_GeomFromWKB, and _ST_MakePoint, along with their parameters and considerations.

• 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 related functions with their parameters, limitations, 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 describes spatial relationship functions in seekdb that test geometric relationships between two values, including intersection, containment, distance calculations, and equality checks. It covers functions such as ST_Intersects, ST_Contains, ST_Distance, ST_Within, and ST_Equals with their syntax and usage examples.

• 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 with their syntax, usage examples, and error conditions.

• 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 parameters.

• 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 for accessing components of spatial data, including _ST_GeometryType, _ST_IsCollection, and _ST_NumInteriorRings functions.

• 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 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 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, returning formatted strings for latency or wait time measurements. Handles values from picoseconds to days and returns NULL for NULL inputs.

• 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 functions, including operations to acquire, check, and release named locks.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/200.get-lock.md

  • Description: This function attempts to acquire a named lock with a specified timeout. It returns 1 for success, 0 for timeout, or NULL for errors, and locks must be explicitly released or are freed 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 (not 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 number of locks successfully released.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/920.lock-functions/600.release-lock.md

  • Description: Releases a named lock previously obtained by the current session, returning a value indicating success, failure, or non-existence of the lock.

• 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 storing, querying, and manipulating compressed bitmap data, including constructors, cardinality calculations, operations, decisions, outputs, and aggregates.

• 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 in seekdb, 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. It also describes 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 documentation covers bitmap cardinality calculation functions in seekdb, including operations for AND, OR, XOR, AND NOT, and aggregate functions for union and 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 in seekdb, including AND, OR, XOR, and ANDNOT operations with their null-handling variants for manipulating bitmap data sets.

• 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: 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 describes bitmap output functions in seekdb, including rb_to_varbinary, rb_to_string, rb_iterate, and rb_to_array, which convert bitmap data into various formats such as binary, string, array, or tabular output.

• 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 creating bitmaps from numeric data, rb_or_agg for performing bitwise OR operations on bitmaps, and rb_and_agg for performing bitwise AND operations on bitmaps.

• 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 constructor, decision, output, and manipulation functions for processing and analyzing array data.

• 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 syntax for creating arrays.

• File Path: 450.reference/200.sql/100.sql-syntax/400.functions/950.array-functions/300.array-decision-functions.md

  • Description: 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: This document describes the array_to_string() function, which converts arrays into formatted strings using specified delimiters and optional null element symbols. It covers syntax, parameters, and provides usage examples for this array output function.

• 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 adding, removing, searching, and transforming array elements, with detailed syntax and examples for each function.

• 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 for configuration, 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 the seekdb system, including 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 describes the map() function and operator for constructing map data types in seekdb, including syntax, parameter requirements, and usage examples.

• 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 between map data types, returning Boolean results based on whether keys and values match exactly. The documentation covers syntax, parameters, and examples for the = and != operators in seekdb.

• 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 the map_keys() and map_values() functions for extracting 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 describes the CURRVAL(SEQ) function, which retrieves the current value of a MySQL sequence, and provides usage examples including sequence creation and data insertion.

• 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, including their types, syntax, and usage in clauses like SELECT, FROM, and WHERE. It covers scalar, correlated, and row subqueries, as well as optimization techniques like unnesting and derived tables.

• File Path: 450.reference/200.sql/100.sql-syntax/500.queries-and-subqueries/300.connection.md

  • Description: Explains database join operations including inner, outer, semi, and anti joins, covering their syntax, conditions, and practical implementations through examples.

• 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, including natural language and boolean search modes, with examples and vectorization options.

• 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 various SQL elements and their valid formats.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1100.alter-compile.md

  • Description: This statement triggers the recompilation of stored procedures or functions, requiring ALTER privilege to execute. It includes optional parameters for reusing original compilation settings.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1200.alter-database.md

  • Description: Modifies database properties including character set, collation, and read/write attributes. The statement allows changes to the current database or a specified database.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1220.alter-external-table.md

  • Description: Refreshes the file list of an external table to manually update its data when automatic updates are not possible. The statement requires specifying the table name to refresh.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1250.alter-materialized-view-in-sql.md

  • Description: This document explains the ALTER MATERIALIZED VIEW statement syntax and usage for modifying materialized view properties, including refresh strategies, parallelism settings, and scheduled refresh cycles.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1251.alter-materialized-view-log-in-sql.md

  • Description: This document explains how to modify a materialized view log's attributes, including parallelism, purge intervals, and LOB storage thresholds, using the ALTER MATERIALIZED VIEW LOG statement. It covers required privileges, syntax, parameters, and provides practical examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1300.alter-outline.md

  • Description: This document explains how to use the ALTER OUTLINE statement to add throttling rules and bind execution plans to existing outlines created with the SQL_TEXT option. It covers syntax, parameters, and important considerations for modifying outlines.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1400.alter-sequence.md

  • Description: Modifies properties of an existing sequence including increment values, range limits, caching behavior, and cycling options. Changes only affect subsequent sequence numbers and require proper schema permissions.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/1600.alter-table.md

  • Description: This document provides the syntax and parameters for the ALTER TABLE statement, which modifies the structure of existing tables by adding, changing, or dropping columns, constraints, indexes, and partitions.

• 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 for these operations.

• 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), including their syntax, usage scenarios, and implementation in seekdb. It covers both non-recursive and recursive CTEs with practical examples for hierarchical data queries.

• 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: Loads specified table indexes into cache to improve query performance, though the functionality is currently not implemented in this version.

• 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 permissions, statement types, and optional keyword filters.

• 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, parameters for setting character sets and read/write attributes, and required privileges.

• 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: This document explains how to create an external table that references data stored outside the database, detailing syntax, parameters, and supported file formats like CSV, Parquet, ORC, and ODPS.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2220.create-index.md

  • Description: This document provides syntax and usage details for creating indexes in seekdb, including unique, full-text, and spatial index types, along with supported tokenizers and storage options. It covers permissions, limitations, and examples for optimizing database query performance.

• 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, with practical examples and references for further guidance.

• 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 in SQL to track incremental changes in base tables, enabling fast refresh of materialized views. 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 SQL outlines using either SQL_TEXT or SQL_ID, detailing the syntax, parameters, and priority rules for binding execution plan hints to specific 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 each method. It also covers limitations, priority rules, and provides practical examples for implementation.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2450.create-role.md

  • Description: This document explains how to create roles using the CREATE ROLE statement, including required privileges, syntax, parameters, and examples. It also covers handling read-only instances and existing roles.

• 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 the CREATE TABLE statement, which is used to create new tables in the database with options for structure, constraints, indexing, partitioning, and storage properties.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/2800.create-user-of-syntax.md

  • Description: Creates new database users with configurable authentication methods, connection requirements, and resource limits. Includes syntax for setting passwords, SSL requirements, and connection constraints.

• 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, updatable view considerations, and permission requirements. It includes examples and references for managing views in the database.

• 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 various scheduling options.

• 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, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/1500.module-data.md

  • Description: This document covers the ALTER SYSTEM LOAD MODULE DATA and ALTER SYSTEM CHECK MODULE DATA statements for importing and verifying module features, with current support limited to the REDIS module.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/2200.flush-plan-cache.md

  • Description: Clears the plan cache for specified databases and SQL statements, with options to target specific queries or apply globally across all 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 statement, covering syntax, permissions, and considerations for parameter effectiveness. It includes practical examples for setting and resetting parameter values.

• 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 through a refresh operation. It includes the syntax, parameter description, 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 THROTTLE statement for controlling SQL request flow by enabling early failure of requests that exceed specified performance metrics like response time or queue wait time. It covers syntax, parameters, and implementation examples for session-based priority throttling.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/300.alter-system/4600.wash-memory-fragmentation.md

  • Description: This document describes the ALTER SYSTEM WASH MEMORY FRAGMENTATION statement, which manually clears memory fragmentation by releasing idle blocks on specified server instances. It covers syntax, parameters, privilege requirements, and provides usage examples for this administrative operation.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3000.deallocate-prepare.md

  • Description: Deallocates a previously prepared SQL statement by name, freeing associated server resources. The syntax supports both DEALLOCATE and DROP commands with the prepared statement identifier.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3200.delete.md

  • Description: This document details the DELETE statement syntax for removing data from single or multiple tables, including parameters, examples, and privilege requirements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3300.describe.md

  • Description: This statement retrieves schema information for tables or columns, with EXPLAIN and DESC serving as equivalent synonyms. It displays field definitions including data types, null constraints, keys, and default values.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3350.drop-catalog.md

  • Description: Drops an external data catalog from the system, requiring CREATE CATALOG privileges to execute. The statement supports an optional IF EXISTS clause to prevent errors when the catalog doesn't exist.

• 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, including its syntax, required privileges, and behavior when removing concurrent limiting rules from the system.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3400.drop-database.md

  • Description: This document describes the DROP DATABASE statement for deleting databases, including its syntax, parameters, and usage examples. It covers the optional IF EXISTS clause to prevent errors when deleting 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 SQL statement, covering its syntax, parameters, and usage for removing unnecessary 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, required privileges, and behavior options including 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 table, requiring DROP TABLE privileges and blocking during active transactions on the base table.

• 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, which removes roles from the database while automatically revoking them from all users and roles. It covers syntax, required privileges, limitations, and operational considerations for successful role deletion.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/3700.drop-table.md

  • Description: This document describes the DROP TABLE statement for deleting tables in seekdb, including syntax, parameters like IF EXISTS and TEMPORARY, and 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, including its syntax, parameters, and usage examples for removing database sequences.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/4000.drop-user.md

  • Description: Drops one or more database users and their associated privileges, with optional conditional syntax for handling non-existent users. Requires the CREATE USER privilege to execute.

• 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 for removing one or more views, including optional parameters, required permissions, and usage examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5200.execute.md

  • Description: Executes a prepared SQL statement, optionally using specified variables to populate parameters in sequence.

• 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, and output formats for optimizing query performance.

• 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, with optional renaming during recovery.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5450.flush-table.md

  • Description: This document describes the FLUSH TABLE statement syntax for clearing internal caches and tables, though the statement currently has no effect unless a specific hidden configuration is enabled.

• 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 assigning roles to users or 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 explains how to use the HELP command to search for topics, categories, and keywords in the database's help system, including syntax, parameters, and examples.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5700.insert-sql.md

  • Description: This document provides the syntax, parameters, and usage examples for the SQL INSERT statement, including data insertion methods, permissions, and limitations for adding records to database tables.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/5800.kill.md

  • Description: This document describes the KILL statement used to terminate client sessions or queries, including syntax, parameters, and required privileges for session management.

• 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, OSS, and URLs into database tables, covering syntax, parameters, and operational considerations.

• 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 currently 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 explains how to use the LOCK TABLES statement to prevent concurrent DML and DDL operations on tables, covering syntax, prerequisites, limitations, and examples.

• 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 the 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: This command modifies usernames in seekdb, requiring CREATE USER privilege. It 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 document explains how to rename one or more tables using the RENAME TABLE statement, covering syntax, required privileges, and important operational limitations during the renaming process.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7600.replace.md

  • Description: This statement inserts records into a table, replacing existing records when primary or unique key conflicts occur. It covers syntax, parameters, and provides examples of usage.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7650.repalr-table.md

  • Description: Repairs potentially damaged tables, though currently only the syntax is supported and the feature is not yet available.

• 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, including syntax, limitations, and privilege requirements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/7800.savepoint.md

  • Description: This document explains how to create and manage savepoints within transactions, including syntax for creating, rolling back to, and releasing savepoints, along with implementation examples and rollback processes.

• 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 in SQL, providing references to related CREATE, ALTER, and DROP DATABASE statements.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8000.select-into.md

  • Description: This document explains the SELECT INTO statement for storing query results into variables or external files, covering syntax, parameters, file formats, and required privileges.

• 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 querying data from tables, required permissions, and detailed parameter descriptions for clauses like WHERE, GROUP BY, and ORDER BY.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/200.join-clause.md

  • Description: This document explains the JOIN clause syntax for combining rows from multiple tables in SeekDB, covering inner and outer join types, permissions, and detailed parameter usage.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8100.select/300.over-clause.md

  • Description: Defines named windows in SELECT queries for use with analytic functions, supporting both ROWS and RANGE frame semantics with partition and order specifications. Includes syntax, parameters, and examples for window function implementation.

• 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, allowing activation of specific roles, all roles, or no roles upon login. 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, supporting direct assignment or values derived from SELECT statements. It covers syntax, parameters, and examples for configuring user and system variables.

• 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 supports switching to either the internal catalog or specified external catalogs.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8300.set-charset.md

  • Description: Sets the character set for client connections and result sets, supporting values like utf8, gbk, and utf16. Allows configuration to either specific character sets 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 set and collation options.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8500.set-password.md

  • Description: This statement changes passwords for the current user or other users in seekdb, requiring CREATE USER privileges to modify other accounts.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8550.set-role.md

  • Description: This document describes the SET ROLE statement, which activates specific roles for the current user session. It covers syntax options including DEFAULT, NONE, ALL, and role-specific parameters with session-level effects.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8600.set-transaction.md

  • Description: Sets the transaction isolation level and access mode for current or subsequent transactions, supporting Read Committed, Repeatable Read, and Serializable levels with global, session, or local scope options.

• 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, including tables, schemas, indexes, status variables, and system metadata.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8750.submit-job.md

  • Description: Creates asynchronous tasks for large-scale data import operations using supported SQL statements like INSERT or LOAD DATA. Returns a job ID for tracking the submitted operation.

• 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 view all jobs, while normal users see only 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. The command returns an error if the job has already completed.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8800.transaction.md

  • Description: This document covers transaction management in SQL, including starting, committing, and rolling back transactions, with syntax and parameter descriptions for maintaining database integrity.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/8900.truncate-table.md

  • Description: This statement completely empties a specified table while retaining its structure and partition information, offering performance advantages over row-by-row deletion. It requires DROP privilege and cannot be executed during transactions or table locks.

• 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 details the UPDATE statement syntax for modifying table data, including parameters, limitations, and usage examples for single and multi-table operations. It also covers required privileges and provides practical scenarios for updating values, partitions, and views.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/9100.use.md

  • Description: Switches to a specified database by accepting the database name as a parameter.

• File Path: 450.reference/200.sql/100.sql-syntax/600.sql-statement/9200.value.md

  • Description: This document describes the VALUES statement, a table-value constructor used to return sets of data rows and combine with operations like UNION. It covers syntax, parameters, and examples for creating and manipulating tabular data.

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

  • Description: This document provides an overview of DDL features supported in seekdb, including operations for indexes, primary keys, columns, generated columns, foreign keys, 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 for each type and guidance on determining whether a specific 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 covers creating, viewing, adding, deleting, and renaming 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 statements. It includes practical examples and references for further information.

• 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, as well as managing default values, constraints, and auto-increment columns. It provides syntax examples and practical demonstrations for each operation.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/500.generated-column-operations.md

  • Description: This document covers the syntax and operations for managing 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 using ALTER TABLE statements with SQL syntax examples.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/700.table-operations.md

  • Description: This document covers how to perform table operations in seekdb, including modifying row format, block size, character set, and renaming tables using ALTER TABLE statements.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/800.partitioning-operations.md

  • Description: This document covers SeekDB's partitioning operations including repartitioning, adding, dropping, and truncating partitions with SQL syntax examples.

• File Path: 450.reference/200.sql/100.sql-syntax/700.ddl-function/900.column-type-change-rule.md

  • Description: This document outlines the rules for changing column data types in seekdb, covering table-level constraints and specific conversion rules between numeric, character, and time data types. It details both Online and Offline DDL operations, including supported scenarios and disabled constraints.

• 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, including fixed-point, unsigned fixed-point, and floating-point numbers. It details the conditions under which conversions between these types are permitted or restricted.

• 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, explaining their read-only nature and listing the specific pseudo columns supported in the current version. It includes links to detailed documentation for PARTITIONID and Sequence pseudo columns.

• File Path: 450.reference/200.sql/100.sql-syntax/800.overview-of-pseudo-columns/200.partititionid-pseudo-column.md

  • Description: This document explains the PARTITIONID pseudo column and its related functions for retrieving partition metadata from database rows, covering syntax, limitations, and feature configuration.

• File Path: 450.reference/200.sql/100.sql-syntax/800.overview-of-pseudo-columns/300.sequence-pseudo-column.md

  • Description: This document explains database sequences and their pseudo columns CURRVAL and NEXTVAL, detailing how to retrieve sequence values and their usage limitations in SQL statements.

• 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 database operations and syntax.

Pl

• File Path: 450.reference/300.pl/100.basic-syntax.md

  • Description: This document covers the basic syntax elements of stored programs, including the structure and usage of BEGIN...END blocks, DECLARE statements for variables and handlers, and statement labels for flow control.

• 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 by processing logic on the server, reduces network interactions, and supports easy development, portability, and centralized management of business logic.

• File Path: 450.reference/300.pl/100.what-is-pl/200.main-functions-of-pl.md

  • Description: PL combines SQL's data processing with procedural language capabilities, supporting variables, control flow, exception handling, and database operations through blocks, packages, and triggers. It enables abstraction features like cursors and composite variables while processing multiple query rows efficiently.

• 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 the six core modules that handle parsing, compilation, and execution of PL code. It also explains the internal caching mechanism that improves execution efficiency by avoiding recompilation.

• File Path: 450.reference/300.pl/1000.pl-system-package/100.system-package-overview.md

  • Description: This documentation covers seekdb's PL system packages, which extend database functionality through encapsulated program objects like stored procedures and functions. It includes descriptions of specific packages for resource management, statistics, SQL rewriting, vector indexes, workload analysis, and materialized views.

• 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 for managing materialized view refresh statistics. It covers subprograms for configuring collection parameters, setting retention periods, and purging outdated statistics.

• 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 during materialized view refreshes. Allows specification of collection detail (none, typical, or advanced) and data retention duration for refresh operations.

• 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 refresh statistics parameters, including collection levels and retention periods. It allows configuration of statistics gathering behavior and data retention duration.

• 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 its 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, with optional parameters to specify precreation time and filter by time unit.

• 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, allowing specification of a group name and optional comment.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/300.create-plan.md

  • Description: This document describes the CREATE_PLAN procedure for creating resource plans in Oracle databases, including syntax, parameters, and usage examples.

• File Path: 450.reference/300.pl/1000.pl-system-package/13300.dbms-resource-manager/400.create-plan-directive.md

  • Description: This procedure creates resource plan directives for managing CPU, I/O, and network bandwidth allocation among resource groups within a database resource plan. It allows administrators to define utilization limits, weights, and thresholds for different resource groups or subplans.

• 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 both the plan and its referenced directives from the database.

• 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 name. 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 maps database sessions to resource consumer groups based on session attributes, allowing administrators to control resource allocation by adding, modifying, or deleting mapping entries. It supports user-based mappings and function-specific mappings for 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 CPU, I/O, and network bandwidth allocation parameters within database resource management. It allows modification of utilization limits, IOPS settings, and bandwidth controls for specified consumer groups or subplans.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/100.dbms-stats-overview.md

  • Description: This package manages database optimizer statistics, providing procedures to collect, modify, delete, export, import, and lock statistics for tables, indexes, columns, and schemas. It also handles statistics 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 database tables to a user-defined statistics table, supporting both partitioned and non-partitioned data structures. Requires appropriate user privileges and compatible character sets between databases.

• 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-defined statistics table, requiring ownership of the table and supporting 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-level statistics and partition statistics. Requires ownership privileges 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 in 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. It is automatically called by statistics gathering procedures and requires no manual execution.

• 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. It covers granularity options, parallelism settings, and exception handling for index statistics operations.

• 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 parallelism. It supports partitioned tables and includes options for histogram collection and index statistics.

• 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, including tables, columns, and indexes, with various configurable parameters for sampling and granularity.

• 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 connecting as a specified user to execute.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/1900.get-stats-history-availability.md

  • Description: Returns the earliest timestamp of available historical statistics, indicating how far back statistics 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. It requires specifying the desired retention period in days as a parameter.

• 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. It returns the number of days that historical statistics are preserved before automatic purging.

• 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. Covers syntax, parameters, exceptions, and includes usage examples.

• 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 parameters including table name, index name, and partition options.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/2400.import-column-stats.md

  • Description: This procedure imports column-level statistics from a user statistics table into the database. It allows control over partition handling, plan cache invalidation, 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 optional column and index statistics, with parameters for partition handling, lock overrides, and plan cache management.

• 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-defined statistics table, with options to control cache invalidation and locked statistics 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 table ownership to execute. It accepts parameters for 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. It requires schema ownership and supports different lock types including ALL, DATA, and CACHE.

• 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 prevents statistics collection or changes while active.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/300.create-stat-table.md

  • Description: Creates a statistics storage table in a specified schema, allowing users to define table name, tablespace, and ownership parameters.

• 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 for database optimization purposes.

• 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 using the DBMS_STATS package. The procedure allows restoring statistics for all objects within a schema while providing options to force restoration and manage plan cache invalidation.

• 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 statistics preferences 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 executed using the CALL DBMS_STATS.RESET_PARAM_DEFAULTS syntax.

• 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 length. It requires table ownership and allows optional parameters for partition handling, plan cache invalidation, and forced execution.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3600.set-index-stats.md

  • Description: Sets index statistics for database optimization, allowing parameters like row count, average length, and block information to be configured. Requires table ownership and supports optional partition specification and cache invalidation control.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3700.set-table-stats.md

  • Description: Sets table-level statistics including row counts, block usage, and average row length for database optimization. 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: Sets global statistics preferences for the database using two VARCHAR2 parameters. The procedure allows configuration of preference names and values through a simple call interface.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/3900.set-param.md

  • Description: Sets the default value of a parameter for procedures in the DBMS_STATS package, requiring SYSDBA privileges and VARCHAR2 inputs. This procedure allows configuration of statistical parameters for database optimization.

• 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 all statistics or only histograms, with parameters for ownership, table and column names, partition handling, and lock overrides.

• 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 schema ownership and proper parameter formatting.

• 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 speed, disk read speeds, and network speed using specified values. 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, including parameters for preference names and values. Requires connection as the target user and proper quoting of all VARCHAR2 parameters.

• 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, index, and histogram statistics. Supports multiple lock types including ALL, DATA, and CACHE parameters.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/4400.unlock-table-stats.md

  • Description: Unlocks table-level statistics and dependent object statistics for specified tables, allowing modification of statistical data. 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 a running statistics collection task by specifying its task ID. The document provides syntax, parameter details, and usage examples for the operation.

• 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, lock status, and plan cache invalidation. It requires appropriate user privileges and supports both partitioned and non-partitioned indexes.

• 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 plan cache invalidation and handling locked statistics.

• 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 force deletion of locked statistics.

• 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.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/860.delete-system-stats.md

  • Description: This document describes the DELETE_SYSTEM_STATS procedure for removing all system statistics, including its syntax, usage requirements, and error handling.

• File Path: 450.reference/300.pl/1000.pl-system-package/15900.dbms-stats/900.delete-table-prefs.md

  • Description: Deletes statistics preferences for specified database tables, requiring appropriate user privileges and parameter inputs. The procedure removes custom settings like degree of parallelism for individual tables.

• 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, 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 procedure creates custom SQL rewrite rules for modifying query patterns, supporting various statement types with specific parameterization requirements.

• File Path: 450.reference/300.pl/1000.pl-system-package/17800.dbms-udr/300.disable-rule.md

  • Description: This procedure disables a custom rewrite rule by name, making it ineffective for query optimization. It requires the rule name as input and supports database management operations.

• 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: The DBMS_VECTOR package manages vector indexes through subprograms that refresh, rebuild, and analyze memory usage for these specialized database structures.

• 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 including index name, table name, vector column, threshold, and refresh type. It supports optional FAST refresh operations for efficient index maintenance.

• 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 incremental data thresholds and parallelism for optimized performance.

• 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 in database tables, requiring updated statistics via ANALYZE TABLE before execution. Supports various index types including HNSW and IVF variants, returning a string with memory recommendations.

• File Path: 450.reference/300.pl/1000.pl-system-package/17850.dbms-vector/500.index-vector-memory-advisor.md

  • Description: Estimates memory usage for vector indexes prior to creation, providing recommended minimum memory values and post-construction memory consumption for different 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 subprograms for creating snapshots, generating reports, modifying settings, and deleting snapshot ranges. All operations 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 events.

• 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 monitoring, resetting the automatic snapshot timer upon execution. It supports TYPICAL snapshots that collect comprehensive statistical data.

• File Path: 450.reference/300.pl/1000.pl-system-package/17900.dbms-workload-repository/400.drop-snapshot-range.md

  • Description: This procedure deletes a specified range of database snapshots by accepting low and high snapshot ID parameters. It is part of the DBMS_WORKLOAD_REPOSITORY package for managing workload repository data.

• 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 collection 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/9950.dbms-mview/100.dbms-mview-overview.md

  • Description: This document provides an overview of the DBMS_MVIEW package, which is used to refresh materialized views and drop materialized view logs. It includes a summary of its subprograms, PURGE_LOG and REFRESH.

• 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 name of the materialized view log to be purged.

• File Path: 450.reference/300.pl/1000.pl-system-package/9950.dbms-mview/300.refresh.md

  • Description: This document describes the REFRESH function for refreshing materialized views, including its syntax, parameters for refresh methods and parallelism, and nested view refresh modes. It provides examples of independent and cascading refresh operations along with common error scenarios.

• 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, or variables. It provides comprehensive alphabetical tables for both keyword categories.

• 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 details their creation, invocation methods, and typical use cases.

• 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 scope rules and data type compatibility. Covers variable declaration, assignment, and resolution of ambiguous names.

• File Path: 450.reference/300.pl/200.storage-object/300.pl-stored-procedure.md

  • Description: This document explains stored procedures, covering their structure, creation using CREATE PROCEDURE with IN/OUT parameters, and execution via CALL statements. It includes practical examples demonstrating parameter usage and result retrieval.

• 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 the required privileges for creation, execution, and modification. It also explains definer security contexts, automatic privilege assignments, 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 and creation requirements including mandatory RETURNS clauses and parameter specifications. It provides syntax examples and demonstrates how to create and call functions that return values.

• File Path: 450.reference/300.pl/200.storage-object/500.pl-trigger.md

  • Description: This document explains database triggers, covering their types, creation syntax, and usage examples. It also details trigger metadata viewing methods and current limitations in seekdb.

• File Path: 450.reference/300.pl/200.storage-object/550.pl-event.md

  • Description: This document describes events, which are predefined SQL tasks that automatically execute at scheduled times or intervals. It covers event creation, scheduling rules, SQL support, dynamic control, and usage considerations for automating database operations.

• 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), triggers, and SQL statements within stored programs. It covers restrictions on specific SQL operations, result sets, transactions, and name resolution conflicts in database programming.

• File Path: 450.reference/300.pl/300.cursor/100.overview-of-cursors.md

  • Description: This document outlines cursor support in PL stored programs, covering declaration requirements and key attributes like insensitivity, read-only status, and non-scrollability.

• File Path: 450.reference/300.pl/300.cursor/200.cursor-execution-process.md

  • Description: This document details the complete cursor execution process in SQL, including declaration, opening, row fetching, and closing procedures with syntax examples. It also covers error handling and provides a practical implementation example.

• 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 for constructing complex conditional logic in SQL, detailing two syntax structures and their execution behaviors. It covers expression matching, search condition evaluation, error handling, and provides implementation examples.

• File Path: 450.reference/300.pl/400.control-statement/200.IF.md

  • Description: This document describes the SQL IF statement syntax and usage for creating conditional logic in stored programs, including clauses, nesting capabilities, and execution rules.

• File Path: 450.reference/300.pl/400.control-statement/300.ITERATE.md

  • Description: This document describes the ITERATE statement, which is used to restart a loop within LOOP, REPEAT, and WHILE statements. It provides the syntax and applicable contexts for its use.

• File Path: 450.reference/300.pl/400.control-statement/400.LEAVE.md

  • Description: The LEAVE statement exits labeled control-flow statements, including loops and stored program blocks, using a specified label. It supports use in BEGIN...END blocks and LOOP, REPEAT, and WHILE statements.

• 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 LEAVE and ITERATE statements for flow control. It provides an example procedure demonstrating loop implementation with labels and conditional termination.

• File Path: 450.reference/300.pl/400.control-statement/600.REPEAT.md

  • Description: Describes the REPEAT statement syntax and usage for executing statements repeatedly until a condition is met, 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 a result to the caller. It covers the statement's syntax, usage requirements, and clarifies that it is not used in stored procedures or triggers.

• 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 requires semicolon-delimited statements within its body.

• File Path: 450.reference/300.pl/500.pl-manipulation-statement-mysql/100.call.md

  • Description: Explains how to use the CALL statement to invoke stored procedures, including syntax for parameter handling and retrieving values through OUT and INOUT parameters.

• File Path: 450.reference/300.pl/500.pl-manipulation-statement-mysql/200.do.md

  • Description: Executes one or more SQL expressions without returning any results, useful for operations like time delays or side effects.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/100.alter-function.md

  • Description: Modifies stored function characteristics such as SQL data access, security context, and comments, but cannot change parameters or function body. Requires ALTER ROUTINE privilege to execute.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/1000.drop-trigger.md

  • Description: This document explains the DROP TRIGGER SQL statement used to delete database triggers, covering syntax options including IF EXISTS clause, schema specification, and required privileges.

• 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 like security settings and data usage types, while noting it cannot change parameters or procedure bodies. It includes syntax examples and required privileges for execution.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/500.create-function.md

  • Description: This document describes the CREATE FUNCTION statement for creating stored functions, including required privileges, syntax parameters, and characteristics that define function behavior and security context.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/600.create-procedure.md

  • Description: This document explains the CREATE PROCEDURE statement for creating stored procedures, covering required privileges, syntax parameters, and execution characteristics. It details how to define input/output parameters, security contexts, and routine behaviors within database operations.

• 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 INSERT, UPDATE, or DELETE operations on tables. It covers trigger structure, timing options, privilege requirements, 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: This document describes the DROP FUNCTION statement, which deletes stored functions. It covers syntax, required privileges, and the optional IF EXISTS clause to prevent errors.

• File Path: 450.reference/300.pl/600.sql-statements-for-pl-stored-programs/900.drop-procedure.md

  • Description: Drops a stored procedure using SQL syntax, including optional error prevention with the IF EXISTS clause. Requires ALTER ROUTINE privilege and provides warnings for non-existent procedures.

• 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 details. Requires appropriate user privileges to execute successfully.

• File Path: 450.reference/300.pl/700.pl-database-management-statements/200.show-create-procedure.md

  • Description: Displays the SQL statement and metadata required to recreate a specific stored procedure, including creation details and required user privileges.

• 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 creation metadata. Requires TRIGGER privilege on the associated table.

• 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 specific 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 specific 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 properties and activation events, with optional filtering by database or table name. Requires TRIGGER privilege to view results.

• 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 characteristics like data types, modes, and positions while excluding built-in functions.

• File Path: 450.reference/300.pl/800.information-schema-dictionary-view/200.information-schema-routines.md

  • Description: Provides information about stored procedures and functions, detailing their structure, metadata, and execution characteristics. Excludes 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, event types, 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 how to define handlers for special conditions and how the server selects appropriate handlers when exceptions occur.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/1000.limitations-of-exception-handling.md

  • Description: This document outlines the exception handling limitations in seekdb's PL feature, including restrictions on prepared statements with SIGNAL/RESIGNAL commands, uniform treatment of SQLSTATE class '04' errors, and recommended workarounds for retrieving error information.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/200.declare-condition.md

  • Description: Declares named exception conditions for SQL error codes or SQLSTATE values, enabling clearer error handling in stored programs through subsequent handler declarations.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/300.declare-handler.md

  • Description: Specifies handlers for SQL exception conditions, defining actions (CONTINUE, EXIT, or UNDO) to execute when specific errors or warnings occur during stored program execution. Covers syntax, condition types, and implementation examples including limitations on label scope within handlers.

• 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 accessing 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 alteration of SQLSTATE values, error codes, or message text while preserving diagnostic context. It requires execution within an active condition handler context and operates by manipulating the diagnostic area stack.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/600.signal.md

  • Description: The SIGNAL statement explicitly returns errors with custom SQLSTATE values, messages, and error codes, typically used in stored programs for error handling. It provides control over error characteristics and impacts program flow based on error categories.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/700.scope-rules-for-handlers.md

  • Description: This document details the scope and selection rules for handlers in stored programs, explaining how their applicability depends on block nesting, condition specificity, and priority. It provides examples demonstrating how handlers are activated based on their proximity to errors and their level of specificity.

• File Path: 450.reference/300.pl/900.pl-exception-handling-statement/800.diagnostic-area.md

  • Description: Explains the structure, contents, and management of SQL diagnostic areas, including statement and condition information items, clearing procedures, and stack operations during stored program execution.

• 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 documentation provides an overview of seekdb's error message format, structure, and categorization, detailing how error codes are organized into specific ranges for compatibility with MySQL and internal system components.

• File Path: 450.reference/600.error-code/1000.9500-9999.md

  • Description: This document covers error codes 9500–9999 related to process language (PL) operations, providing causes and solutions for issues including parameter usage, object declarations, and function definitions.

• 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 causes and solutions for routing, TTL, authentication, schema mismatches, and permission-related issues.

• File Path: 450.reference/600.error-code/1100.22998-30926-38104-38105.md

  • Description: This document covers four database error codes related to BLOB/CLOB data types, non-deterministic WHERE clauses, ON clause column updates, and missing rows due to concurrent deletions. It provides causes and solutions for each error.

• File Path: 450.reference/600.error-code/200.0001-3999.md

  • Description: This document provides a comprehensive listing of error codes 0001–3999 that are compatible with MySQL, detailing each error's description and corresponding seekdb error code. It serves as a reference for database administrators and developers working with MySQL-compatible systems.

• File Path: 450.reference/600.error-code/300.4000-4499.md

  • Description: This document covers general error codes 4000–4499 for seekdb, including common issues like timeouts, memory limits, initialization errors, and network problems, with recommended solutions.

• 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 permission issues with corresponding solutions.

• File Path: 450.reference/600.error-code/600.6000-6999.md

  • Description: Documents error codes 6000-6999 related to object layer transactions, MVCC, and CLOG operations, including causes and solutions for transaction conflicts, timeouts, and system-level failures.

• File Path: 450.reference/600.error-code/800.8000-8999.md

  • Description: This document covers error codes 8000-8999, which indicate serious SQL connection errors requiring immediate closure. It provides specific details on initialization, shutdown, and packet checksum errors along with their solutions.

Telemetry

• File Path: 450.reference/700.telemetry/700.telemetry.md

  • Description: seekdb's telemetry feature collects anonymized technical usage data by default to help improve the product, while protecting privacy by hashing sensitive information. Users can disable telemetry via an environment variable and view collected data in a local JSON file.

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, with installation via pip and prerequisites including Python 3.11 or later.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/10.pyseekdb-simple-sample.md

  • Description: This example demonstrates basic Embedding Functions operations in SeekDB's embedded mode, covering collection creation, document insertion with automatic vector generation, and text-based querying with automatic embedding conversion.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/100.pyseekdb-hybrid-search-sample.md

  • Description: Demonstrates hybrid_search() advantages over query(), including simultaneous full-text and vector search with independent filters and RRF result fusion.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/30.sdk-samples/50.pyseekdb-complete-sample.md

  • Description: A comprehensive example demonstrating pyseekdb's full capabilities including connection modes, collection management, DML/DQL operations, and hybrid search functionality.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/10.api-overview.md

  • Description: This API reference covers seekdb's database, collection, DML, and DQL operations, detailing methods for creating, retrieving, updating, deleting, and querying data through both AdminClient and Client connections.

• 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 or OceanBase Database instances, supporting functions like creating, querying, deleting, and listing databases. It uses the same connection modes as the standard Client but is restricted to administrative tasks.

• 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, including available APIs for creating, querying, listing, and deleting databases.

• 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 specified 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 method retrieves a list of databases from a SeekDB instance, including details such as name, character set, and collation. It is exclusively available through the AdminClient and supports optional pagination parameters.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/110.database/500.delete-database-of-api.md

  • Description: This document explains the delete_database() method for removing databases, detailing its prerequisites, required parameters, and usage within the AdminClient. It includes specific requirements for different database modes and provides a code example for implementation.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/100.create-collection-of-api.md

  • Description: This API creates a new database table (collection) with optional vector embedding configuration and index parameters, requiring client connection and appropriate user privileges.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/200.get-collection-of-api.md

  • Description: Retrieves an existing collection by name, with optional configuration and embedding function parameters. Requires a connected client and existing collection to return collection metadata 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 or retrieves a collection in the database, allowing configuration of vector dimensions, distance metrics, and embedding functions. It requires client usage and proper database privileges.

• 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 a database using a client connection, returning details such as name, dimension, embedding function, distance metric, and metadata for each collection.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/350.count-collection-of-api.md

  • Description: Counts the number of collections in a database using the count_collection() method, which requires an active client connection and pyseekdb installation.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/400.delete-collection-of-api.md

  • Description: Deletes a specified collection from the database when connected via a client, requiring the collection name as a parameter. This operation is only available with an active client connection and requires the collection to exist.

• File Path: 450.reference/900.sdk/10.pyseekdb-sdk/50.apis/200.collection/50.collection-overview-of-api.md

  • Description: This document covers pyseekdb's collection management API, which enables creating, querying, listing, counting, and deleting database-like 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, detailing APIs for inserting, updating, and deleting data in collections.

• 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, accepting IDs, embeddings, documents, and metadata parameters. It requires client mode and returns 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: The update() method modifies existing records in a collection by updating IDs, embeddings, documents, or metadatas, requiring the records to already exist. It is available only when using a Client with proper database connection and user privileges.

• 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 ones in a database collection, 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 explains how to use the delete() method to remove records from a collection by ID, metadata filter, or document filter, including prerequisites and code 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 batch queries, metadata filtering, and text-to-vector conversions 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 specified parameters.

• 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. Supports metadata filtering and 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 details filter operators for API data and text 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, and provides APIs for managing collections. 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 explains the DefaultEmbeddingFunction in pyseekdb, which converts text to vector embeddings using a pre-configured model. It covers basic usage, dimension retrieval, and references custom embedding function options.

• 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 implement custom embedding functions when creating or retrieving collections, enabling automatic vector generation for documents and queries. It provides code examples for collection operations using custom embeddings.

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 and Q&A with local data storage for privacy.

• File Path: 500.tutorials/100.create-ai-app-demo/300.build-multi-model-application-based-on-oceanbase.md

  • Description: This guide demonstrates how to build a cultural tourism assistant using OceanBase's multi-model integration, combining spatial data, vector search, and LLM Agent workflows for personalized attraction recommendations and travel planning.

• File Path: 500.tutorials/100.create-ai-app-demo/400.build-image-search-app-in-seekdb.md

  • Description: This guide explains how to build an image search application using seekdb's vector search technology, covering setup, image loading, and search functionality. It includes prerequisites, step-by-step procedures, and a demonstration of the application interface.

• 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 with long-term memory using the TEN Framework and OceanBase PowerMem, covering integration, memory strategies, and deployment steps.

• 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. It includes setup instructions, environment configuration, and steps for importing Markdown documents and running the application.

• File Path: 500.tutorials/200.scenarios/15.basic-sql-operations.md

  • Description: This document covers basic SQL operations in seekdb, including creating and managing databases, tables, indexes, and performing data manipulation with INSERT, DELETE, and UPDATE statements.

• File Path: 500.tutorials/200.scenarios/30.experience-vector-search.md

  • Description: This document provides a technical overview of seekdb's vector search capabilities, including storage, indexing, and SQL-based implementation for both exact and approximate nearest neighbor searches. It demonstrates practical examples for creating vector columns, inserting data, and performing similarity searches with different distance metrics.

• 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, covering setup, querying, and performance tuning with practical examples and comparisons.

• File Path: 500.tutorials/200.scenarios/50.experience-hybrid-search.md

  • Description: This tutorial demonstrates how to use seekdb's hybrid search feature, which combines full-text keyword search and vector-based semantic search to deliver more accurate and comprehensive results. It includes practical examples 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 like text generation, embedding, and reranking directly into SQL queries for practical applications.

• File Path: 500.tutorials/200.scenarios/70.experience-hybrid-vector-index.md

  • Description: This tutorial introduces seekdb's hybrid vector index, which automatically converts text to vectors for semantic retrieval without manual embedding. It covers index creation, data insertion, and retrieval using both text and precomputed vectors.

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. Examples include vector search for document Q&A and image retrieval using SQL+AI integration.

---

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