https://foundationdb.github.io/fdb-record-layer/SQL_Reference.html

[ ] [ ]
Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Toggle site navigation sidebar
 
FoundationDB Record Layer documentation
Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar
FoundationDB Record Layer documentation
[                    ] 
  * Overview and Examples
  * Getting Started Guide
  * Building
  * Schema Evolution and Meta-data Maintenance
  * Extending the Record Layer
  * Versioning Guide
  * Coding Best Practices
  * Release Notes
  * Frequently Asked Questions
  * SQL Reference[*]
    Toggle navigation of SQL Reference
      + SQL Data Types
      + SQL Commands[ ]
        Toggle navigation of SQL Commands
          o DQL[ ]
            Toggle navigation of DQL
              # SELECT
              # WITH
              # WHERE
              # EXPLAIN
              # Operators[ ]
                Toggle navigation of Operators
                  @ Logical Operators[ ]
                    Toggle navigation of Logical Operators
                      - EXISTS
                  @ Comparison Operators
                  @ IS Operator
          o DDL[ ]
            Toggle navigation of DDL
              # CREATE[ ]
                Toggle navigation of CREATE
                  @ CREATE SCHEMA TEMPLATE
                  @ CREATE DATABASE
                  @ CREATE SCHEMA
                  @ CREATE TABLE
                  @ CREATE TYPE[ ]
                    Toggle navigation of CREATE TYPE
                      - CREATE TYPE AS STRUCT
                      - CREATE TYPE AS ENUM
                  @ CREATE INDEX
              # DROP[ ]
                Toggle navigation of DROP
                  @ DROP SCHEMA TEMPLATE
                  @ DROP DATABASE
                  @ DROP SCHEMA
          o DML[ ]
            Toggle navigation of DML
              # INSERT
              # UPDATE
              # DELETE
      + Functions[ ]
        Toggle navigation of Functions
          o Aggregate Functions[ ]
            Toggle navigation of Aggregate Functions
              # BITMAP_CONSTRUCT_AGG
          o Scalar Functions[ ]
            Toggle navigation of Scalar Functions
              # BITMAP_BIT_POSITION
              # BITMAP_BUCKET_NUMBER
              # BITMAP_BUCKET_OFFSET
      + Databases, Schemas, Schema Templates
      + Tables
      + Indexes
      + Direct Access API
      + Understanding How Bitmaps Identify Distinct Values
  * API[ ]
    Toggle navigation of API
      + fdb-java-annotations
      + fdb-extensions
      + fdb-record-layer-core
      + fdb-record-layer-icu
      + fdb-record-layer-lucene
      + fdb-record-layer-spatial
      + fdb-relational-api
      + fdb-relational-core
      + fdb-relational-cli
      + fdb-relational-grpc
      + fdb-relational-jdbc
  * Contributing
  * Code of Conduct
  * License

Back to top
View this page
Toggle Light / Dark / Auto color theme
Toggle table of contents sidebar

SQL ReferenceP

The FDB relational subproject provides a SQL API for interacting with
Record Layer databases. This SQL API is currently under active
development and is expected to change frequently. This reference is
currently also a work in progress to be updated as the SQL engine
develops.

SQL

  * SQL Data Types
      + Primitive Types
      + Struct Types
      + Array types
      + NULL Semantics
  * SQL Commands
      + DQL
      + DDL
      + DML
  * Functions
      + Aggregate Functions
      + Scalar Functions

Data Model

  * Databases, Schemas, Schema Templates
      + Schemas
      + Databases
      + Schema Templates
      + Bridging a pre-existing Record Layer setup
  * Tables
      + Single row tables
  * Indexes
      + Defining indexes
      + Indexes on nested fields
      + Index rules
      + Implementation details

Miscellaneous

  * Direct Access API
      + Scan
      + Get
      + Insert
      + Delete
  * Understanding How Bitmaps Identify Distinct Values

 
Next
SQL Data Types
 
Previous
FoundationDB Record Layer FAQ
Copyright (c) 2025, Apple Inc.
Made with Furo