ScyllaDB

https://docs.scylladb.com/manual/master/
Admin
ScyllaDB is a distributed NoSQL wide-column database designed for data-intensive applications...
Tokens:399,098
Snippets:4,987
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start ScyllaDB Service

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/scylla-web-installer.html

Start the ScyllaDB server as a systemd service after configuration and setup are complete.

```bash
sudo systemctl start scylla-server

```

--------------------------------

### Create Roles for Examples

Source: https://docs.scylladb.com/manual/master/features/workload-prioritization.html

Before following the examples, create the 'Spark' and 'Web' roles. Permissions can be assigned later.

```cql
CREATE ROLE Spark;
CREATE ROLE Web;

```

--------------------------------

### Install Specific ScyllaDB Patch Version (Example) on Debian/Ubuntu

Source: https://docs.scylladb.com/manual/master/getting-started/install-scylla/install-on-linux.html

Example command to install ScyllaDB version 2025.3.1 and its related packages on Debian/Ubuntu systems.

```bash
apt-get install scylla{,-server,-kernel-conf,-node-exporter,-conf,-python3,-cqlsh}=2025.3.1-0.20250907.2bbf3cf669bb-1

```

--------------------------------

### Start ScyllaDB Monitoring with Manager Dashboard

Source: https://docs.scylladb.com/manual/master/troubleshooting/manager-monitoring-integration.html

Execute this command to start ScyllaDB Monitoring, including the Manager Dashboard. The `-M` flag specifies the Manager Dashboard version, and example versions are provided.

```bash
/start-all.sh -s path/to/scylla_servers.yml -n path/to/node_exporter_servers.yml -d path/to/mydata -v 3.0 -M 2.0
```

--------------------------------

### Start ScyllaDB Server

Source: https://docs.scylladb.com/manual/master/upgrade/upgrade-guides/upgrade-guide-from-2026.x.y-to-2026.x.z.html

Command to start the ScyllaDB server after an upgrade or rollback.

```bash
sudo service start scylla-server
```

--------------------------------

### Create Users Table and Index

Source: https://docs.scylladb.com/manual/master/cql/dml/select.html

Defines the 'users' table with primary key 'username' and a secondary index on 'birth_year'. This setup is necessary for the subsequent query examples.

```cql
CREATE TABLE users (
    username text PRIMARY KEY,
    firstname text,
    lastname text,
    birth_year int,
    country text
)

CREATE INDEX ON users(birth_year);

```

--------------------------------

### Install ScyllaDB Manager

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/scylla-web-installer.html

Install the latest official version of ScyllaDB Manager, including both server and client packages, using the Web Installer.

```bash
curl -sSf get.scylladb.com/manager | sudo bash

```

--------------------------------

### Example Key File Content

Source: https://docs.scylladb.com/manual/master/operating-scylla/security/encryption-at-rest.html

An example of the expected output format for a ScyllaDB encryption key file.

```text
AES/CBC/PKCS5Padding:128:8stVxW5ypYhNxsnRVS1A6suKhk0sG4Tj

```

--------------------------------

### Start ScyllaDB Service

Source: https://docs.scylladb.com/manual/master/upgrade/upgrade-guides/upgrade-guide-from-2026.1-to-2026.2/upgrade-guide-from-2026.1-to-2026.2.html

Start the ScyllaDB server service on the node after the upgrade.

```bash
sudo service scylla-server start

```

--------------------------------

### Example finalize migration status

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

An example output after finalizing the migration, showing the keyspace status as 'tablets'.

```bash
$ scylla nodetool migrate-to-tablets finalize ks
Keyspace: ks
Status: tablets


```

--------------------------------

### Build Spark Example with Maven

Source: https://docs.scylladb.com/manual/master/kb/scylla-and-spark-integration.html

Compile the Spark example application using Maven.

```bash
mvn compile

```

--------------------------------

### Nodetool Backup Example

Source: https://docs.scylladb.com/manual/master/operating-scylla/nodetool-commands/backup.html

An example of using the nodetool backup command to back up a specific table's snapshot to an S3 bucket. This example includes the endpoint, bucket, prefix, keyspace, table, snapshot, and the --move-files option.

```bash
nodetool backup --endpoint s3.us-east-2.amazonaws.com  --bucket bucket-foo --prefix foo/bar/baz --keyspace ks --table table --snapshot ss --move-files

```

--------------------------------

### Install Specific ScyllaDB Patch Version (Example) on CentOS/RHEL

Source: https://docs.scylladb.com/manual/master/getting-started/install-scylla/install-on-linux.html

Example command to install ScyllaDB version 2025.3.1 using yum on CentOS/RHEL systems.

```bash
sudo yum install scylla-2025.3.1

```

--------------------------------

### Example ScyllaDB Instance Launch

Source: https://docs.scylladb.com/manual/master/getting-started/install-scylla/launch-on-gcp.html

An example of launching a ScyllaDB instance with specific image and machine type configurations.

```bash
gcloud compute instances create scylla-node1 --image scylladb-5-2-1 --image-project scylla-images --local-ssd interface=nvme --machine-type=n1-highmem-8
```

--------------------------------

### Create ScyllaDB Keyspace and Use

Source: https://docs.scylladb.com/manual/master/kb/scylla-and-spark-integration.html

Creates a new keyspace named 'spark_example' with NetworkTopologyStrategy and sets it as the current keyspace for subsequent operations.

```sql
CREATE KEYSPACE spark_example WITH replication = {'class': 'NetworkTopologyStrategy', 'replication_factor': 3};
USE spark_example;
```

--------------------------------

### Response Example: Integer List

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Example of a successful response returning a list of integers.

```json
[
  0
]
```

--------------------------------

### Install boto3 Python Library

Source: https://docs.scylladb.com/manual/master/alternator/getting-started.html

Installs the boto3 library, which includes drivers for DynamoDB, using pip.

```bash
sudo pip install --upgrade boto3
```

--------------------------------

### Example Keyspace Creation with SimpleStrategy

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/cluster-management/update-topology-strategy-from-simple-to-network.html

Illustrates the initial creation of a keyspace using SimpleStrategy with a replication factor of 3. This serves as a 'before' state for the alteration process.

```sql
CREATE KEYSPACE mykeyspace WITH replication = { 'class' : 'SimpleStrategy', 'replication_factor': '3'};
```

--------------------------------

### get /storage_service/is_starting

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Returns whether the storage service is starting or not.

```APIDOC
## get /storage_service/is_starting

### Description
Returns whether the storage service is starting or not.

### Method
GET

### Endpoint
/storage_service/is_starting

### Response
#### Success Response (200)
boolean

```

--------------------------------

### ScyllaDB Example CREATE USER Statements

Source: https://docs.scylladb.com/manual/master/operating-scylla/security/authorization.html

Illustrates how to create users with and without superuser privileges, including setting passwords.

```sql
CREATE USER alice WITH PASSWORD 'password_a' SUPERUSER;
CREATE USER bob WITH PASSWORD 'password_b' NOSUPERUSER;
```

--------------------------------

### Get Endpoints Example Output

Source: https://docs.scylladb.com/manual/master/operating-scylla/nodetool-commands/toppartitions.html

Example output of the nodetool getendpoints command, showing the IP address of the node holding the specified partition key.

```text
10.0.0.72
```

--------------------------------

### Example Output of 'scylla --help'

Source: https://docs.scylladb.com/manual/master/getting-started/config-commands.html

This is an example of the output from the 'scylla --help' command, showing available options and their descriptions. Note that this is an incomplete view.

```text
scylla version 4.2.3-0.20210104.24346215c2 with build-id 0c8faf8bb8a3a0eda9337aad98ed3a6d814a4fa9 starting ...
command used: "scylla --help"
parsed command line options: [help]
scylla options:
  -h [ --help ]                         show help message
  --version                             print version number and exit
  --options-file arg                    configuration file (i.e.
                                        <SCYLLA_HOME>/conf/scylla.yaml)
  --memtable-flush-static-shares arg    If set to higher than 0, ignore the
                                        controller's output and set the
                                        memtable shares statically. Do not set
                                        this unless you know what you are doing
                                        and suspect a problem in the
                                        controller. This option will be retired
                                        when the controller reaches more
                                        maturity
  --compaction-static-shares arg        If set to higher than 0, ignore the
                                        controller's output and set the
                                        compaction shares statically. Do not
                                        set this unless you know what you are
                                        doing and suspect a problem in the
                                        controller. This option will be retired
                                        when the controller reaches more
                                        maturity


```

--------------------------------

### Package Conflict Error Example

Source: https://docs.scylladb.com/manual/master/faq.html

This error occurs when trying to install scylla-tools on a server that already has Apache Cassandra installed, due to conflicting 'nodetool' binaries.

```bash
Unpacking scylla-tools (1.0.1-20160411.b9fe89b-ubuntu1) ...
dpkg: error processing archive /var/cache/apt/archives/scylla-tools_1.0.1-20160411.b9fe89b-ubuntu1_all.deb (--unpack) \
 trying to overwrite '/usr/bin/nodetool', which is also in package cassandra 2.1.4


```

--------------------------------

### Nodetool cfhistograms Example

Source: https://docs.scylladb.com/manual/master/operating-scylla/nodetool-commands/cfhistograms.html

This example demonstrates how to use `nodetool cfhistograms` to get statistics for the `standard1` table within the `keyspaces1` keyspace. The output provides a percentile breakdown of various performance metrics.

```bash
nodetool cfhistograms keyspaces1 standard1
```

--------------------------------

### Run ScyllaDB Setup Script

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/unified-installer.html

Initialize ScyllaDB configuration by running the setup script located in the scylladb sbin directory.

```bash
~/scylladb/sbin/scylla_setup

```

--------------------------------

### Example migration status (node uses tablets)

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

An example output of the `migrate-to-tablets status` command showing that a node has successfully transitioned to using tablets.

```bash
$ scylla nodetool migrate-to-tablets status ks
Keyspace: ks
Status: migrating_to_tablets

Nodes:
Host ID                                Status
99d8de76-3954-4727-911a-6a07251b180c   uses tablets  <---
0b5fd6f6-9670-4faf-a480-ad58cf119007   uses vnodes
017dd39a-3d06-4c8a-8ac4-379f9e595607   uses vnodes


```

--------------------------------

### Run scylla_swap_setup Script to Configure Swap

Source: https://docs.scylladb.com/manual/master/kb/set-up-swap.html

Execute the `scylla_swap_setup` script to create and enable swap space. Specify the directory for the swap file and its size in GB.

```bash
sudo scylla_swap_setup --swap-directory /tmp/swp --swap-size SWAP_SIZE 500
```

--------------------------------

### Create Table with CDC Enabled

Source: https://docs.scylladb.com/manual/master/features/cdc/cdc-preimages.html

Defines a table with Change Data Capture (CDC) enabled and preimages configured. This is the initial setup for the examples.

```sql
CREATE TABLE ks.t (pk int, ck int, v int, PRIMARY KEY (pk, ck)) WITH cdc = {'enabled': true, 'preimage': true};
UPDATE ks.t SET v = 0 WHERE pk = 0 AND ck = 0;

```

--------------------------------

### Get Compaction History

Source: https://docs.scylladb.com/manual/master/reference/api/compaction-manager.html

Retrieves the history of completed compaction tasks. This includes information on when compactions started and finished, data processed, and details about tombstone purges.

```json
[
  {
    "id": "string",
    "shard_id": 0,
    "cf": "string",
    "ks": "string",
    "compaction_type": "string",
    "started_at": 0,
    "compacted_at": 0,
    "bytes_in": 0,
    "bytes_out": 0,
    "rows_merged": [
      {
        "key": 0,
        "value": 0
      }
    ],
    "sstables_in": [
      {
        "generation": "string",
        "origin": "string",
        "size": 0
      }
    ],
    "sstables_out": [
      {
        "generation": "string",
        "origin": "string",
        "size": 0
      }
    ],
    "total_tombstone_purge_attempt": 0,
    "total_tombstone_purge_failure_due_to_overlapping_with_memtable": 0,
    "total_tombstone_purge_failure_due_to_overlapping_with_uncompacting_sstable": 0
  }
]
```

--------------------------------

### Run ScyllaDB Setup Script

Source: https://docs.scylladb.com/manual/master/getting-started/install-scylla/install-on-linux.html

Execute the scylla_setup script to tune system settings and generate optimal configuration files for ScyllaDB.

```bash
sudo scylla_setup
```

--------------------------------

### ScyllaDB Examples of CREATE ROLE Statements

Source: https://docs.scylladb.com/manual/master/operating-scylla/security/authorization.html

Provides examples of creating roles with different configurations, including basic creation, password and login settings, superuser status, and custom options.

```cql
CREATE ROLE new_role;
```

```cql
CREATE ROLE alice WITH PASSWORD = 'password_a' AND LOGIN = true;
```

```cql
CREATE ROLE bob WITH PASSWORD = 'password_b' AND LOGIN = true AND SUPERUSER = true;
```

```cql
CREATE ROLE carlos WITH OPTIONS = { 'custom_option1' : 'option1_value', 'custom_option2' : 99 };
```

--------------------------------

### Get Current Node Time

Source: https://docs.scylladb.com/manual/master/features/cdc/cdc-stream-changes.html

Periodically check the current time of the connected node using the `now()` function. This is useful for determining when a new CDC generation starts operating.

```cql
SELECT totimestamp(now()) FROM system.local;
```

--------------------------------

### Example Keyspace Creation with NetworkTopologyStrategy

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/cluster-management/update-topology-strategy-from-simple-to-network.html

Shows the 'after' state of a keyspace after altering it to NetworkTopologyStrategy, specifying the data center and replication factor.

```sql
CREATE KEYSPACE mykeyspace WITH replication = { 'class' : 'NetworkTopologyStrategy', '<existing_dc>' : 3};
```

--------------------------------

### Set Default Log Level Offline

Source: https://docs.scylladb.com/manual/master/troubleshooting/log-level.html

Configure the default log level for all ScyllaDB classes when starting the service by editing the SCYLLA_ARGS parameter. This example sets the default to debug.

```bash
--default-log-level debug

```

--------------------------------

### Example Table Creation with Compaction Strategy

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/change-compaction.html

This example shows how a table might be created with a specific compaction strategy defined. It serves as a reference for understanding table structure and compaction settings.

```sql
CREATE TABLE nba.team_roster (
    player_name text PRIMARY KEY,
    player_jersy_number int,
    player_position text,
    team text
) AND compaction = {'class': 'SizeTieredCompactionStrategy'};
```

--------------------------------

### AssemblyScript Wasm UDF Example

Source: https://docs.scylladb.com/manual/master/cql/wasm.html

An AssemblyScript implementation of a Fibonacci function, suitable for Wasm UDFs when 'RETURNS NULL ON NULL INPUT' is specified. Requires installation via npm.

```typescript
export const _scylla_abi = [1]
export function fib(n: i32): i32 {
if (n < 2) {
    return n
}
return fib(n - 1) + fib(n - 2)
}

```

--------------------------------

### Run ScyllaDB Setup Script

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/scylla-web-installer.html

Execute the scylla_setup script to tune system settings and benchmark storage, which generates the io.conf file required for ScyllaDB to run.

```bash
sudo scylla_setup

```

--------------------------------

### Set Multiple Logger Levels Offline

Source: https://docs.scylladb.com/manual/master/troubleshooting/log-level.html

Configure specific log levels for multiple ScyllaDB classes when starting the service by editing the SCYLLA_ARGS parameter. This example sets sstable to debug and cql_server to trace.

```bash
--logger-log-level sstable=debug:cql_server=trace

```

--------------------------------

### Start Migration for Multiple Keyspaces

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

Initiates the migration process to tablets for specified keyspaces. Ensure each keyspace is prepared individually before proceeding.

```bash
scylla nodetool migrate-to-tablets start <keyspace1>
scylla nodetool migrate-to-tablets start <keyspace2>
...
```

--------------------------------

### Start vnode to tablet migration

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

Initiates the migration process for a given keyspace. This command prepares the keyspace for the transition to tablets.

```bash
scylla nodetool migrate-to-tablets start <keyspace>

```

--------------------------------

### get /storage_service/keyspaces

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the keyspaces.

```APIDOC
## get /storage_service/keyspaces

### Description
Get the keyspaces.

### Method
GET

### Endpoint
/storage_service/keyspaces

### Response
#### Success Response (200)
- **keyspace** (string)

### Response Example
{
  "example": [
    "string"
  ]
}

```

--------------------------------

### Display Help for scylla_swap_setup Script

Source: https://docs.scylladb.com/manual/master/kb/set-up-swap.html

View the available options and arguments for the `scylla_swap_setup` script, which is used to configure swap space for ScyllaDB.

```bash
scylla_swap_setup --help
```

--------------------------------

### Install ScyllaDB as Non-Root User

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/unified-installer.html

Execute the installation script with the --nonroot flag to install ScyllaDB without root privileges.

```bash
./install.sh --nonroot

```

--------------------------------

### get /storage_service/snapshots

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the details of all the snapshot.

```APIDOC
## get /storage_service/snapshots

### Description
Get the details of all the snapshot.

### Method
GET

### Endpoint
/storage_service/snapshots

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **key** (string, optional) - The snapshot key
- **value** (Array[snapshot], optional) - The column family

##### snapshot
- **ks** (string, optional) - The key space snapshot key
- **cf** (string, optional) - The column family
- **total** (integer, optional) - The total snapshot size
- **live** (integer, optional) - The live snapshot size

#### Response Example
```json
[
  {
    "key": "string",
    "value": [
      {
        "ks": "string",
        "cf": "string",
        "total": 0,
        "live": 0
      }
    ]
  }
]
```
```

--------------------------------

### ScyllaDB Node Startup Log

Source: https://docs.scylladb.com/manual/master/features/cdc/cdc-stream-changes.html

Example log entry showing the startup of a ScyllaDB node.

```log
INFO  2020-02-06 17:59:35,087 [shard 0] init - ScyllaDB version 666.development-0.20200206.9eae0b57a with build-id 052adc1eb0601af2 starting ...

```

--------------------------------

### Install Specific ScyllaDB Manager Version

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/scylla-web-installer.html

Install a specific version of ScyllaDB Manager by using the --manager-version option with the Web Installer.

```bash
curl -sSf get.scylladb.com/manager | sudo bash -s -- --manager-version 3.10

```

--------------------------------

### Example CREATE KEYSPACE Statement

Source: https://docs.scylladb.com/manual/master/cql/ddl.html

An example of creating a keyspace named 'Excalibur' with specific replication and durable write options.

```cql
CREATE KEYSPACE Excalibur
WITH replication = {'class': 'NetworkTopologyStrategy', 'DC1' : ['RAC1', 'RAC2', 'RAC3'], 'DC2' : 3}
AND durable_writes = true;
```

--------------------------------

### Create User, Role, and Grant Permissions

Source: https://docs.scylladb.com/manual/master/operating-scylla/security/enable-authorization.html

This example demonstrates creating a new user 'db_user' with a password, creating a role 'client' with SELECT permissions on a specific table, and then granting the 'client' role to 'db_user'.

```cql
CREATE ROLE db_user WITH PASSWORD = 'password' AND LOGIN = true;
CREATE ROLE client;
GRANT SELECT ON ks.t1 TO client;
GRANT client TO db_user;

```

--------------------------------

### Example migration status (node migrating)

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

An example output of the `migrate-to-tablets status` command after a node has been marked for upgrade, showing its status as 'migrating to tablets'.

```bash
$ scylla nodetool migrate-to-tablets status ks
Keyspace: ks
Status: migrating_to_tablets

Nodes:
Host ID                                Status
99d8de76-3954-4727-911a-6a07251b180c   migrating to tablets  <---
0b5fd6f6-9670-4faf-a480-ad58cf119007   uses vnodes
017dd39a-3d06-4c8a-8ac4-379f9e595607   uses vnodes


```

--------------------------------

### Upgrade ScyllaDB (Root Install)

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/unified-installer.html

Upgrade an existing ScyllaDB installation using the install.sh script with the --upgrade flag for root installations.

```bash
./install.sh --upgrade

```

--------------------------------

### Example: Node status after downgrade initiation

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

Example output after initiating a node downgrade, showing the status change from 'uses tablets' or 'migrating to tablets' to 'migrating to vnodes'.

```bash
$ scylla nodetool migrate-to-tablets status ks
Keyspace: ks
Status: migrating_to_tablets

Nodes:
Host ID                                Status
99d8de76-3954-4727-911a-6a07251b180c   migrating to vnodes  <---
0b5fd6f6-9670-4faf-a480-ad58cf119007   migrating to tablets
017dd39a-3d06-4c8a-8ac4-379f9e595607   uses vnodes

```

--------------------------------

### get /storage_service/drain

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the progress of a drain operation.

```APIDOC
## get /storage_service/drain

### Description
Get the progress of a drain operation.

### Method
GET

### Endpoint
/storage_service/drain

### Response
#### Success Response (200)
string

```

--------------------------------

### get /storage_service/logging_level

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the runtime logging levels.

```APIDOC
## get /storage_service/logging_level

### Description
Get the runtime logging levels.

### Method
GET

### Endpoint
/storage_service/logging_level

### Response
#### Success Response (200)
- **key** (string, optional) - The key
- **value** (string, optional) - The value

### Response Example
{
  "example": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

```

--------------------------------

### Create Table with KMIP Key Provider Example

Source: https://docs.scylladb.com/manual/master/operating-scylla/security/encryption-at-rest.html

An example of creating a table with the KmipKeyProviderFactory, specifying the KMIP host. Template name and namespace are optional.

```cql
CREATE TABLE myks.mytable (...<columns>...) WITH
  scylla_encryption_options = {
    'cipher_algorithm' :  'AES/CBC/PKCS5Padding',
    'secret_key_strength' : 128,
    'key_provider': 'KmipKeyProviderFactory',
    'kmip_host': 'my-kmip1'
  }
;
```

--------------------------------

### get /storage_service/removal_status

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the status of a token removal.

```APIDOC
## get /storage_service/removal_status

### Description
Get the status of a token removal.

### Method
GET

### Endpoint
/storage_service/removal_status

### Response
#### Success Response (200)
- (string) - (No specific description provided)
```

--------------------------------

### Example migration status (vnodes)

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

An example output of the `migrate-to-tablets status` command showing that all nodes in the keyspace are still using vnodes.

```bash
$ scylla nodetool migrate-to-tablets status ks
Keyspace: ks
Status: migrating_to_tablets

Nodes:
Host ID                                Status
99d8de76-3954-4727-911a-6a07251b180c   uses vnodes
0b5fd6f6-9670-4faf-a480-ad58cf119007   uses vnodes
017dd39a-3d06-4c8a-8ac4-379f9e595607   uses vnodes


```

--------------------------------

### get /storage_service/saved_caches/location

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get location of the saved caches dir.

```APIDOC
## get /storage_service/saved_caches/location

### Description
Get location of the saved caches dir.

### Method
GET

### Endpoint
/storage_service/saved_caches/location

### Response
#### Success Response (200)
- Type: string

#### Response Example
```json
"string"
```
```

--------------------------------

### Example CPU Pinning Output

Source: https://docs.scylladb.com/manual/master/getting-started/system-configuration.html

This is an example of what the output from `cat /etc/scylla.d/cpuset.conf` might look like, indicating the CPUs allocated to ScyllaDB.

```bash
--cpuset `1-15,17-31`
```

--------------------------------

### get /stream_manager/metrics/incoming

Source: https://docs.scylladb.com/manual/master/reference/api/stream-manager.html

Get the total incoming bytes for all peers.

```APIDOC
## GET /stream_manager/metrics/incoming

### Description
Get all total incoming bytes

### Method
GET

### Endpoint
/stream_manager/metrics/incoming

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **int64** - The total incoming bytes for all peers.

### Response Example
```json
0
```
```

--------------------------------

### get /stream_manager/metrics/outbound

Source: https://docs.scylladb.com/manual/master/reference/api/stream-manager.html

Get the number of active outbound streams.

```APIDOC
## GET /stream_manager/metrics/outbound

### Description
Get number of active outbound streams

### Method
GET

### Endpoint
/stream_manager/metrics/outbound

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **int64** - The number of active outbound streams.

### Response Example
```json
0
```
```

--------------------------------

### get /storage_service/data_file/locations

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the list of all data file locations from conf.

```APIDOC
## get /storage_service/data_file/locations

### Description
Get the list of all data file locations from conf.

### Method
GET

### Endpoint
/storage_service/data_file/locations

### Response
#### Success Response (200)
- Model: Array[string]

#### Response Example
```json
[
  "string"
]
```
```

--------------------------------

### Example 1: ScyllaDB on CPUs 3,4,5 with IRQs on same CPUs and shared NIC

Source: https://docs.scylladb.com/manual/master/kb/customizing-cpuset.html

This configuration is for a 16-CPU system where ScyllaDB runs on CPUs 3, 4, and 5. IRQs are handled on the same CPUs, and other applications can use the NIC `eth5` for XFS/RFS/RPS.

```bash
CPUSET="--cpuset 3,4,5 "
```

```yaml
cpu_mask: '0xffff'
dir:
- /var/lib/scylla
irq_cpu_mask: '0x38'
nic:
- eth5
tune:
- net
- disks
```

--------------------------------

### get /column_family/metrics/write_latency/histogram/

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get write latency histogram of all column families.

```APIDOC
## get /column_family/metrics/write_latency/histogram/

### Description
Get write latency histogram of all column families.

### Method
GET

### Endpoint
/column_family/metrics/write_latency/histogram/

### Response
#### Success Response (200)
Model: Inline Model [#/utils/histogram]
Example Value:
```json
[
  null
]
```
```

--------------------------------

### Example: CREATE TABLE and UPDATE with Atomic Columns

Source: https://docs.scylladb.com/manual/master/features/cdc/cdc-advanced-types.html

Demonstrates creating a table with CDC enabled and performing updates, including setting a column to null. Shows how to query the CDC log table to observe the changes.

```sql
CREATE TABLE ks.t (pk int, ck int, v int, PRIMARY KEY (pk, ck)) WITH cdc = {"enabled": true};
UPDATE ks.t SET v = 0 WHERE pk = 0 AND ck = 0;
UPDATE ks.t SET v = null WHERE pk = 0 AND ck = 0;
SELECT "cdc$time", pk, ck, v, "cdc$deleted_v" from ks.t_scylla_cdc_log;
```

--------------------------------

### get /column_family/metrics/range_latency

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get all range latency metrics for column families.

```APIDOC
## get /column_family/metrics/range_latency

### Description
Get all range latency metrics for column families.

### Method
GET

### Endpoint
/column_family/metrics/range_latency

### Response
#### Success Response (200)
Data Type: int64
```

--------------------------------

### get /column_family/metrics/read_latency

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get all read latency metrics for column families.

```APIDOC
## get /column_family/metrics/read_latency

### Description
Get all read latency metrics for column families.

### Method
GET

### Endpoint
/column_family/metrics/read_latency

### Response
#### Success Response (200)
Data Type: int64
```

--------------------------------

### Example: Checking Partition Size

Source: https://docs.scylladb.com/manual/master/troubleshooting/debugging-large-partition.html

This example demonstrates how to use `nodetool cfstats` to find the maximum partition size for the 'tmcr' table in the 'demodb' keyspace.

```bash
nodetool cfstats demodb.tmcr | grep "Compacted partition maximum bytes"

                Compacted partition maximum bytes: 1188716932

```

--------------------------------

### Create Keyspace with Rack-List Replication

Source: https://docs.scylladb.com/manual/master/cql/ddl.html

Demonstrates creating a keyspace using NetworkTopologyStrategy with a rack list for replication, ensuring replicas are placed in specific racks.

```cql
CREATE KEYSPACE Excelsior
 WITH replication = { 'class' : 'NetworkTopologyStrategy', 'dc1' : ['RAC1', 'RAC2']};
```

--------------------------------

### Install Specific ScyllaDB Version via Tarball

Source: https://docs.scylladb.com/manual/master/getting-started/installation-common/scylla-web-installer.html

Install a specific version of ScyllaDB Server using the tarball installation method by specifying the desired version with the --scylla-version flag.

```bash
curl -sSf get.scylladb.com/server | sudo bash -s -- --tarball --scylla-version |CURRENT_VERSION|

```

--------------------------------

### get /storage_service/snapshots/size/true

Source: https://docs.scylladb.com/manual/master/reference/api/storage-service.html

Get the true size taken by all snapshots across all keyspaces.

```APIDOC
## get /storage_service/snapshots/size/true

### Description
Get the true size taken by all snapshots across all keyspaces.

### Method
GET

### Endpoint
/storage_service/snapshots/size/true

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **int64**

Response Content Type application/json
```

--------------------------------

### Create ScyllaDB Keyspace and Table

Source: https://docs.scylladb.com/manual/master/using-scylla/integrations/integration-databricks.html

Prepare your ScyllaDB database by creating a keyspace named 'databriks' and a table 'demo1' within it. This example uses NetworkTopologyStrategy for replication.

```sql
CREATE KEYSPACE databriks WITH replication = {'class': 'NetworkTopologyStrategy', 'replication_factor' : 3};
CREATE TABLE databriks.demo1 (pk text PRIMARY KEY, ck1 text, ck2 text);
INSERT INTO databriks.demo1  (pk, ck1, ck2) VALUES ('pk', 'ck1', 'ck2');

```

--------------------------------

### get /column_family/metrics/write/

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get the number of writes from all column families, per shard.

```APIDOC
## get /column_family/metrics/write/

### Description
Get the number of writes from all column families, per shard.

### Method
GET

### Endpoint
/column_family/metrics/write/

### Response
#### Success Response (200)
Model: Inline Model [integer]
Example Value:
```json
[
  0
]
```
```

--------------------------------

### ScyllaDB.partition_start

Source: https://docs.scylladb.com/manual/master/operating-scylla/admin-tools/scylla-sstable-script-api.html

Represents the start of a partition, including its key, token, and potential tombstone.

```APIDOC
## ScyllaDB.partition_start

### Description
Represents the start of a partition.

### Attributes
* `key` - The partition key's value in the appropriate Lua native type.
* `token` (integer) - The partition key's token.
* `tombstone` (ScyllaDB.tombstone) - The partition tombstone; `nil` if no tombstone exists.
```

--------------------------------

### List All API Modules with scylla-api-client

Source: https://docs.scylladb.com/manual/master/operating-scylla/admin.html

Use the `scylla-api-client` to list all available API modules. This helps in discovering the different categories of commands you can execute.

```bash
scylla-api-client --list-modules
```

--------------------------------

### get /column_family/metrics/write/{name}

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get the number of writes for a specific column family.

```APIDOC
## get /column_family/metrics/write/{name}

### Description
Get the number of writes for a specific column family.

### Method
GET

### Endpoint
/column_family/metrics/write/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The column family name in keyspace:name format

### Response
#### Success Response (200)
Data Type: int64
```

--------------------------------

### Example 3: ScyllaDB on CPUs 3,4,5 with IRQs on separate CPUs and shared NIC

Source: https://docs.scylladb.com/manual/master/kb/customizing-cpuset.html

This configuration is for a 16-CPU system where ScyllaDB runs on CPUs 3, 4, and 5. IRQs are handled on CPUs 6, 7, and 8, and other applications can use the NIC `eth5` for XFS/RFS/RPS.

```bash
CPUSET="--cpuset 3,4,5 "
```

```yaml
cpu_mask: '0xffff'
dir:
- /var/lib/scylla
irq_cpu_mask: '0x1c0'
nic:
- eth5
tune:
- net
- disks
```

--------------------------------

### get /column_family/metrics/write_latency/{name}

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get write latency for a specific column family.

```APIDOC
## get /column_family/metrics/write_latency/{name}

### Description
Get write latency for a specific column family.

### Method
GET

### Endpoint
/column_family/metrics/write_latency/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The column family name in keyspace:name format

### Response
#### Success Response (200)
Data Type: int64
```

--------------------------------

### Example List Permissions Statements

Source: https://docs.scylladb.com/manual/master/operating-scylla/security/authorization.html

These examples show how to list permissions for users, optionally filtering by resource or excluding inherited permissions.

```sql
LIST ALL PERMISSIONS OF alice;
```

```sql
LIST ALL PERMISSIONS ON keyspace1.table1 OF bob;
```

```sql
LIST SELECT PERMISSIONS OF carlos;
```

--------------------------------

### get /column_family/metrics/range_latency/{name}

Source: https://docs.scylladb.com/manual/master/reference/api/column-family.html

Get range latency for a specific column family.

```APIDOC
## get /column_family/metrics/range_latency/{name}

### Description
Get range latency for a specific column family.

### Method
GET

### Endpoint
/column_family/metrics/range_latency/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The column family name in keyspace:name format

### Response
#### Success Response (200)
Data Type: int64
```

--------------------------------

### Example: Migration status output

Source: https://docs.scylladb.com/manual/master/operating-scylla/procedures/config-change/migrate-vnodes-to-tablets.html

An example of the output from the `migrate-to-tablets status` command, showing different node statuses.

```bash
$ scylla nodetool migrate-to-tablets status ks
Keyspace: ks
Status: migrating_to_tablets

Nodes:
Host ID                                Status
99d8de76-3954-4727-911a-6a07251b180c   uses tablets  <---
0b5fd6f6-9670-4faf-a480-ad58cf119007   migrating to tablets  <---
017dd39a-3d06-4c8a-8ac4-379f9e595607   uses vnodes

```

--------------------------------

### get /stream_manager/metrics/outgoing/{peer}

Source: https://docs.scylladb.com/manual/master/reference/api/stream-manager.html

Get the total outgoing bytes for a specific peer.

```APIDOC
## GET /stream_manager/metrics/outgoing/{peer}

### Description
Get total outgoing bytes

### Method
GET

### Endpoint
/stream_manager/metrics/outgoing/{peer}

### Parameters
#### Path Parameters
- **peer** (string) - Required - The stream peer

### Request Example
None

### Response
#### Success Response (200)
- **int64** - The total outgoing bytes.

### Response Example
```json
0
```
```

--------------------------------

### get /stream_manager/metrics/incoming/{peer}

Source: https://docs.scylladb.com/manual/master/reference/api/stream-manager.html

Get the total incoming bytes for a specific peer.

```APIDOC
## GET /stream_manager/metrics/incoming/{peer}

### Description
Get total incoming bytes

### Method
GET

### Endpoint
/stream_manager/metrics/incoming/{peer}

### Parameters
#### Path Parameters
- **peer** (string) - Required - The stream peer

### Request Example
None

### Response
#### Success Response (200)
- **int64** - The total incoming bytes.

### Response Example
```json
0
```
```
Tokens:
Raw