• Products
    • CrateDB
    • CrateDB Cloud
    • Crate IoT Data Platform
    • CrateDB in Comparison
  • Use Cases
    • Customers
    • IoT & Sensor Data
    • Time Series
    • Geospatial Analytics
    • Cybersecurity
  • Resources
    • Documentation
    • Resource Library
    • Community
    • Partners
  • Pricing
  • Blog
  • Get CrateDB
  • Products
    • CrateDB
    • CrateDB Cloud
    • Crate IoT Data Platform
    • CrateDB in Comparison
  • Use Cases
    • Customers
    • IoT & Sensor Data
    • Time Series
    • Geospatial Analytics
    • Cybersecurity
  • Resources
    • Documentation
    • Resource Library
    • Community
    • Partners
  • Pricing
  • Blog
  • Get CrateDB
Toggle Doc Menu
Search Documentation
    • CrateDB
      • Getting Started
      • Reference
        • Running CrateDB
          • Introduction
          • Command Line Options
          • Signal Handling
        • Configuration
          • Node Specific Settings
            • Basics
            • Node Types
            • Read-only node
            • Hosts
            • Ports
            • Paths
            • Plugins
            • Memory
            • Garbage Collection
            • Elasticsearch HTTP REST API
            • Cross-Origin Resource Sharing (CORS)
            • Blobs
            • Repositories
            • Queries
            • Custom Attributes
          • Cluster Wide Settings
            • Non-Runtime Cluster Wide Settings
            • Collecting Stats
            • Usage Data Collector
            • Graceful Stop
            • Bulk Operations
            • Discovery
            • Routing Allocation
            • Recovery
            • Query Circuit Breaker
            • Field Data Circuit Breaker
            • Request Circuit Breaker
            • Stats Circuit Breakers
            • Thread Pools
            • Metadata
          • Session Setting Parameters
          • Logging
            • Application Logging
            • Garbage Collection Logging
          • Environment Variables
            • CRATE_HOME
            • CRATE_JAVA_OPTS
            • CRATE_HEAP_SIZE
            • CRATE_GC_*
            • CRATE_HEAP_DUMP_PATH
          • Operating System Configuration
            • Virtual Memory
          • Enterprise Features
            • Enterprise License
            • Javascript Language
            • Authentication
            • Secured Communications (SSL/TLS)
        • General Use
          • Data Definition
            • Creating Tables
            • Data Types
            • System Columns
            • Generated Columns
            • Constraints
            • Storage
            • Partitioned Tables
            • Sharding
            • Replication
            • Column Policy
            • Fulltext Indices
            • Fulltext Analyzers
            • Show Create Table
            • Views
            • Altering Tables
          • Data Manipulation
            • Inserting Data
            • Updating Data
            • Deleting Data
            • Import and Export
          • Querying Crate
            • Selecting Data
            • Joins
            • Union All
            • Refresh
            • Fulltext Search
            • Geo Search
          • Built-in Functions and Operators
            • Scalar Functions
            • Aggregation
            • Arithmetic Operators
            • Table Functions
            • Comparison Operators
            • Array Comparisons
            • Subquery Expressions
          • User-Defined Functions
            • CREATE OR REPLACE
            • Supported Types
            • Overloading
            • Determinism
            • DROP FUNCTION
            • Supported Languages
          • Blobs
            • Creating a Table for Blobs
            • Custom Location for Storing Blob Data
            • List
            • Altering a Blob Table
            • Deleting a Blob Table
            • Using Blob Tables
          • Optimistic Concurrency Control
            • Introduction
            • Optimistic Update
            • Optimistic Delete
            • Known Limitations
          • Information Schema
            • Access
            • Virtual Tables
        • Administration
          • System Information
            • Cluster
            • Nodes
            • Node Checks
            • Shards
            • Jobs, Operations, and Logs
            • Cluster Checks
            • Health
            • Repositories
            • Snapshots
            • Summits
            • Users
            • Allocations
            • Shard Table Permissions
          • Runtime Configuration
          • User Management
            • Introduction
            • CREATE USER
            • ALTER USER
            • DROP USER
            • List Users
          • Privileges
            • Introduction
            • Privilege Types
            • Hierarchical Inheritance of Privileges
            • Behavior of GRANT, DENY and REVOKE
            • List Privileges
          • Authentication
            • Authentication Methods
            • Host Based Authentication (HBA)
          • Secured Communications (SSL/TLS)
            • SSL/TLS Configuration
            • Setting up a Keystore/Truststore With a Certificate Chain
          • Ingestion Framework
            • Ingestion Sources
            • Ingestion Rules
          • Optimization
            • Introduction
            • Multiple Table Optimization
            • Partition Optimization
            • Segments Upgrade
          • Jobs Management
          • JMX Monitoring
            • Setup
            • Using Docker
            • JMX Beans
            • Exposing JMX via HTTP
          • Snapshots
            • Snapshot
            • Restore
            • Cleanup
            • Requirements for Using HDFS Repositories
          • Cloud Discovery
            • Amazon EC2 Discovery
            • Microsoft Azure Discovery
          • Usage Data Collector
            • Technical Information
            • Admin UI Tracking
            • Configuration
            • How to Disable UDC
        • SQL Syntax
          • General SQL
            • Constraints
            • Value Expressions
            • Lexical Structure
          • SQL Statements
            • ALTER CLUSTER
            • ALTER TABLE
            • ALTER USER
            • COPY FROM
            • COPY TO
            • CREATE ANALYZER
            • CREATE BLOB TABLE
            • CREATE FUNCTION
            • CREATE INGEST RULE
            • CREATE REPOSITORY
            • CREATE SNAPSHOT
            • CREATE TABLE
            • CREATE USER
            • CREATE VIEW
            • DEALLOCATE
            • DELETE
            • DENY
            • DROP FUNCTION
            • DROP INGEST RULE
            • DROP REPOSITORY
            • DROP SNAPSHOT
            • DROP TABLE
            • DROP USER
            • DROP VIEW
            • EXPLAIN
            • GRANT
            • INSERT
            • KILL
            • OPTIMIZE
            • REFRESH
            • RESTORE SNAPSHOT
            • REVOKE
            • SELECT
            • SET and RESET
            • SET TRANSACTION
            • SHOW COLUMNS
            • SHOW CREATE TABLE
            • SHOW SCHEMAS
            • SHOW TABLES
            • UPDATE
        • Client Interfaces
          • HTTP Endpoint
            • Introduction
            • Parameter Substitution
            • Default Schema
            • Column Types
            • Bulk Operations
            • Error Handling
          • PostgreSQL Wire Protocol
            • Introduction
            • Server Compatibility and Implementation Status
            • Client Compatibility
            • Implementation Differences
        • Enterprise Features
        • Appendices
          • Release Notes
            • Versions
            • Older Versions
          • Compatibility
            • Implementation Notes
            • Unsupported Features and Functions
          • SQL Standard Compliance
      • Guide
    • CrateDB Cloud
      • Console
      • Croud CLI
    • CrateDB Clients
      • CrateDB Admin UI
      • CrateDB Shell
      • JDBC
      • PHP DBAL
      • PHP PDO
      • Python
      • .NET Npgsql
    • Sample Applications
    • Support
v:3.0
latest 3.2 3.1 3.0 2.3 1.2 0.57

CrateDB ReferenceΒΆ

CrateDB is a distributed SQL database that makes it simple to store and analyze massive amounts of machine data in real-time.

Note

This is a low-level reference manual.

Check out Getting Started With CrateDB for beginner documentation.

Check out the CrateDB Guide for high-level documentation, including overviews, best practices, and tutorials.

See also

CrateDB is an open source project and is hosted on GitHub.

Table of Contents

  • Running CrateDB
    • Introduction
    • Command Line Options
    • Signal Handling
  • Configuration
    • Node Specific Settings
    • Cluster Wide Settings
    • Session Setting Parameters
    • Logging
    • Environment Variables
    • Operating System Configuration
    • Enterprise Features
  • General Use
    • Data Definition
    • Data Manipulation
    • Querying Crate
    • Built-in Functions and Operators
    • User-Defined Functions
    • Blobs
    • Optimistic Concurrency Control
    • Information Schema
  • Administration
    • System Information
    • Runtime Configuration
    • User Management
    • Privileges
    • Authentication
    • Secured Communications (SSL/TLS)
    • Ingestion Framework
    • Optimization
    • Jobs Management
    • JMX Monitoring
    • Snapshots
    • Cloud Discovery
    • Usage Data Collector
  • SQL Syntax
    • General SQL
    • SQL Statements
  • Client Interfaces
    • HTTP Endpoint
    • PostgreSQL Wire Protocol
  • Enterprise Features
  • Appendices
    • Release Notes
    • Compatibility
    • SQL Standard Compliance

Product

  • CrateDB
  • CrateDB Cloud
  • Crate IoT Data Platform
  • CrateDB Community Edition
  • CrateDB Comparison
  • MQTT Broker
  • Event Hubs Integration
  • Telegraf Output Plugin
  • Prometheus Adapter
  • Pricing
  • Get CrateDB

Use Cases

  • Customers
  • Use Cases
  • IoT & Sensors
  • Time Series
  • Geospatial Tracking
  • Cybersecurity

Resources

  • Resource Library
  • Blog
  • Events
  • Community
  • Contribute
  • Github

Documentation

  • Get started
  • Full References
  • User Guide
  • Support

Company

  • About us
  • Jobs
  • Partners
  • OEM Partners
  • Systems Integrator Partners
  • Technology Partners
  • Press
  • Contact
  • Legal
  • Imprint