Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla Java Driver Manual Query builder Schema builder Keyspace

Keyspace¶

A keyspace is a top-level namespace that defines a name, replication strategy and configurable options. SchemaBuilder offers API methods for creating, altering and dropping keyspaces.

Creating a Keyspace (CREATE KEYSPACE)¶

To start a CREATE KEYSPACE query, use createKeyspace in SchemaBuilder:

import static com.datastax.oss.driver.api.querybuilder.SchemaBuilder.*;

CreateKeyspaceStart create = createKeyspace("cycling");

Like all other CREATE queries, one may supply ifNotExists() to require that the keyspace should only be created if it doesn’t already exist, i.e.:

CreateKeyspaceStart create = createKeyspace("cycling").ifNotExists();

Note that, at this stage, the query cannot be completed yet. You need to provide at least a replication strategy. The two most widely used ones are SimpleStrategy and NetworkTopologyStrategy.

To provide a replication strategy, use one of the following API methods on CreateKeyspaceStart:

  • withSimpleStrategy(int replicationFactor)

  • withNetworkTopologyStrategy(Map<String, Integer> replications)

  • withReplicationOptions(Map<String, Object> replicationOptions)

For example, the following builds a completed CreateKeyspace using NetworkTopologyStrategy with a replication factor of 2 in east and 3 in west:

CreateKeyspace create = createKeyspace("cycling")
    .withNetworkTopologyStrategy(ImmutableMap.of("east", 2, "west", 3));
// CREATE KEYSPACE cycling WITH replication={'class':'NetworkTopologyStrategy','east':2,'west':3}

Optionally, once a replication factor is provided, one may provide additional configuration when creating a keyspace:

  • withDurableWrites(boolean durableWrites)

  • withOption(String name, Object value)

Altering a Keyspace (ALTER KEYSPACE)¶

To start an ALTER KEYSPACE query, use alterKeyspace:

AlterKeyspaceStart alterKeyspace = alterKeyspace("cycling");

From here, you can modify the keyspace’s replication and other settings:

  • withSimpleStrategy(int replicationFactor)

  • withNetworkTopologyStrategy(Map<String, Integer> replications)

  • withReplicationOptions(Map<String, Object> replicationOptions)

  • withDurableWrites(boolean durableWrites)

  • withOption(String name, Object value)

At least one of these operations must be used to return a completed AlterKeyspace, i.e.:

alterKeyspace("cycling").withDurableWrites(true);
// ALTER KEYSPACE cycling WITH durable_writes=true

Dropping a keyspace (DROP KEYSPACE)¶

To create a DROP KEYSPACE query, use dropKeyspace:

dropKeyspace("cycling");
// DROP KEYSPACE cycling

You may also specify ifExists:

dropKeyspace("cycling").ifExists();
// DROP KEYSPACE IF EXISTS cycling
PREVIOUS
Index
NEXT
Materialized View
  • 4.13.0.x
    • 4.13.0.x
    • 4.12.0.x
    • 4.11.1.x
    • 4.10.0.x
    • 4.7.2.x
    • 3.11.2.x
    • 3.11.0.x
    • 3.10.2.x
    • 3.7.2.x
  • Java Driver for Scylla and Apache Cassandra®
  • API Documentation
  • Manual
    • API conventions
    • Case sensitivity
    • Core driver
      • Address resolution
      • Asynchronous programming
      • Authentication
      • Bill of Materials (BOM)
      • Compression
      • Configuration
        • Reference configuration
      • Control connection
      • Custom codecs
      • Detachable types
      • Using the driver in GraalVM native images
      • Query idempotence
      • Integration
      • Load balancing
      • Logging
      • Metadata
        • Node metadata
        • Schema metadata
        • Token metadata
      • Metrics
      • Native protocol
      • Non-blocking programming
      • Paging
      • Performance
      • Connection pooling
      • Query timestamps
      • Reactive Style Programming
      • Reconnection
      • Request tracker
      • Retries
      • Using the shaded JAR
      • Speculative query execution
      • SSL
      • Statements
        • Batch statements
        • Per-query keyspace
        • Prepared statements
        • Simple statements
      • Temporal types
      • Request throttling
      • Query tracing
      • Tuples
      • User-defined types
    • Developer docs
      • Administrative tasks
      • Common infrastructure
        • Concurrency
        • Driver context
        • Event bus
      • Native protocol layer
      • Netty pipeline
      • Request execution
    • Mapper
      • Integration
        • Kotlin
        • Lombok
        • Java 14 Records
        • Scala
      • DAOs
        • Custom result types
        • Delete methods
        • GetEntity methods
        • Increment methods
        • Insert methods
        • Null saving strategy
        • Query methods
        • Query provider methods
        • Select methods
        • SetEntity methods
        • Statement attributes
        • Update methods
      • Entities
      • Mapper interface
    • OSGi
    • Query builder
      • Conditions
      • DELETE
      • Idempotence in the query builder
      • INSERT
      • Relations
      • Schema builder
        • Aggregate
        • Function
        • Index
        • Keyspace
        • Materialized View
        • Table
        • Type
      • SELECT
      • Terms
      • TRUNCATE
      • UPDATE
  • Upgrade guide
  • Frequently asked questions
  • Changelog
  • Create an issue
  • Edit this page

On this page

  • Keyspace
    • Creating a Keyspace (CREATE KEYSPACE)
    • Altering a Keyspace (ALTER KEYSPACE)
    • Dropping a keyspace (DROP KEYSPACE)
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 25 May 2022.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.2.2