SingleStore DB

CREATE DATABASE

Creates a database.

Syntax
CREATE DATABASE [IF NOT EXISTS] <database_name> [<sync_options>] [PARTITIONS n]
    [<create_specification>] 
 [{FOR | INTO | ON} <object_store_settings>] 
   
<sync_options>: 
WITH {SYNC | ASYNC} DURABILITY 
 | WITH {SYNC | ASYNC} REPLICATION | WITH {SYNC | ASYNC} DURABILITY {SYNC | ASYNC} REPLICATION 

<create_specification>:
    [DEFAULT] CHARACTER SET [=] charset_name 

<object_store_settings>: 
<S3_object_store_configuration> 
|   <AZURE_object_store_configuration>
|   <GCS_object_store_configuration> 

<S3_object_store_configuration>:
    S3 { '<bucket-name>' | '<bucket-name/path>' }
      [CONFIG '<configuration_json>']
      CREDENTIALS '<credentials_json>' 
<AZURE_object_store_configuration>:
    AZURE { '<container-name>' | '<container-name/object-name>' | '<container-name/prefix/object-name>' }
      [CONFIG '<configuration_json>']
      CREDENTIALS '<credentials_json>'

<GCS_object_store_configuration>: 
    GCS {'<bucket-name>' | '<bucket-name/path>' }
    [CONFIG '<configuration_json>']
    CREDENTIALS '<credentials_json>' 

-- "schema" is an alias for "database"
CREATE SCHEMA [IF NOT EXISTS]..

Note

GCS is currently a preview feature.

Remarks
  • database_name is the name to assign to this new SingleStore database. Do not use the _XX suffix (such as test_database_01) while naming a SingleStore DB database as it may cause a mismatch with the database partition ordinals (sharded databases on each leaf node).

  • CONFIG and CREDENTIALS can be specified in either order (CONFIG followed by CREDENTIALS or CREDENTIALS followed by CONFIG).

  • To create a local storage database, exclude the {FOR | INTO | ON} <object_store_settings> option. To create an unlimited storage database use the {FOR | INTO | ON} <object_store_settings> option. Note that FOR, INTO, and ON are synonyms and their functionality is identical.

    Prior to creating an unlimited storage database, the enable_bottomless engine variable must be set to ON (the default value). For more information on local storage and unlimited storage databases, see Local and Unlimited Database Storage Concepts.

    Unlimited storage databases cannot be created in the SingleStore DB Free Edition.

  • WITH {SYNC | ASYNC} REPLICATION specifies whether high availability, redundancy-2 replication will be done synchronously or asynchronously. Synchronous replication from the master partitions will complete on all replicas before the commit of the transaction is acknowledged to the client application. If WITH {SYNC | ASYNC} REPLICATION is not specified, synchronous replication is used. See Replication and Durability Concepts for more information.

  • WITH {SYNC | ASYNC} DURABILITY specifies whether in-memory database updates you make using DDL and DML commands are also saved to the log on disk synchronously or asynchronously. Synchronous updates to the log on disk will complete before the commit of the transaction is acknowledged to the client application. If WITH {SYNC | ASYNC} DURABILITY is not specified, async durability is used. See Replication and Durability Concepts for more information.

  • You cannot specify WITH SYNC DURABILITY ASYNC REPLICATION.

  • PARTITIONS n allows you to set the total number of partitions that the data will be split into. By default this is controlled by the default_partitions_per_leaf variable. Note that n refers to the total number of partitions across all leaves.

  • The CREATE DATABASE ... DEFAULT CHARSET= syntax is accepted by SingleStore for compatibility with MySQL, but it has no effect. The database and its schema objects use the server character set and collation.

  • To enable Ceph compatibility, set the ceph_mode flag to true in the CONFIG:

    CREATE DATABASE db INTO S3 { '<bucket-name>' | '<bucket-name/path>' } CONFIG '{"ceph_mode":true}' CREDENTIALS '{<...>}';

    This does not apply to the SingleStore DB Free Edition since this edition does not support the creation of unlimited storage databases.

  • Node Requirements for SingleStore DB Commands

Examples

The following example creates a local database that uses all of the default options.

CREATE DATABASE IF NOT EXISTS test;

The following example creates a local database that uses sync durability and sync replication. The latter is enabled by default.

CREATE DATABASE IF NOT EXISTS test WITH SYNC DURABILITY;

The following example creates an unlimited storage database.

CREATE DATABASE bottomless_db ON S3 "bottomless_db_bucket/bottomless_db_folder"
  CONFIG '{"region":"us-east-1"}'
  CREDENTIALS '{"aws_access_key_id":"your_access_key_id","aws_secret_access_key":"your_secret_access_key"}';