Files

Andrei Chekun 85769131a2 docs: update documentation with new way of running C++ tests

Documentation had outdated information how to run C++ test.
Additionally, some information added about gathered test metrics.

Closes scylladb/scylladb#25180

(cherry picked from commit a6a3d119e8)

Closes scylladb/scylladb#25291

2025-08-06 07:25:44 +03:00

advanced_rpc_compression_negotiation.tla

utils: add advanced_rpc_compressor

2024-12-23 23:37:02 +01:00

advanced_rpc_compression.md

utils: correct misspellings

2025-01-02 16:47:57 +02:00

api_v2.md

docs: dev: correct a typo

2023-03-31 17:19:08 +03:00

audit.md

audit: Add documentation for the audit subsystem

2025-01-15 11:10:35 +01:00

backport.md

Typos: fix typos in documentation

2023-12-07 11:10:17 +02:00

building.md

build: replace tools/java submodule with packaged cassandra-stress

2025-04-15 10:11:28 +03:00

cdc.md

Fix typos

2025-02-11 00:17:43 +02:00

code-coverage.md

Fix typos

2025-02-11 00:17:43 +02:00

commitlog-file-format.md

docs: Add entry on commitlog file format v4

2024-09-03 16:38:28 +00:00

compaction_controller.md

docs: dev: write mathematical expressions in LaTeX

2023-03-29 15:07:14 +03:00

compilation-time-analysis.md

Fix typos

2025-02-11 00:17:43 +02:00

cql3-type-mapping.md

docs: add vector type documentation

2025-01-28 21:14:49 +01:00

cql-extensions-internal.md

…

debugging.md

Fix typos

2025-02-11 00:17:43 +02:00

describe_schema.md

schema: add per-table tablet options

2025-02-06 08:55:51 +02:00

docker-hub.md

dist/docker,docs: replace "--experimental" with "--experimental-features"

2025-01-14 07:56:38 -05:00

file_encryption.md

docs: Add EAR docs

2025-01-09 10:40:47 +00:00

hinted_handoff_design.md

docs: Update Hinted Handoff documentation

2024-04-28 01:22:59 +02:00

IDL.md

Typos: more/less then -> more/less than

2024-02-13 17:16:15 +02:00

isolation.md

Fix typos

2025-02-13 01:54:08 +02:00

logging.md

…

lua-type-mapping.md

docs: add vector type documentation

2025-01-28 21:14:49 +01:00

maintainer.md

docs/dev/maintainer.md: clarify "Updating submodule references"

2024-09-05 13:57:32 +03:00

metrics.md

Fix typos

2025-02-11 00:17:43 +02:00

migrating-from-users-to-roles.md

…

modules.md

forward_service: rename to mapreduce_service

2024-07-03 19:29:47 +03:00

mvcc.md

doc: Introduce docs/dev/mvcc.md

2023-01-27 19:15:39 +01:00

object_storage.md

Add dev documentation for manipulating s3 data manually

2025-06-17 13:21:30 +03:00

paged-queries.md

treewide: rename flat_mutation_reader_v2 to mutation_reader

2024-06-21 07:12:06 +03:00

parallel_aggregations.md

…

per-partition-rate-limit.md

Typos: fix typos in documentation

2023-12-07 11:10:17 +02:00

protocol-extensions.md

transport: implement SCYLLA_USE_METADATA_ID support

2025-05-14 09:59:16 +02:00

protocols.md

Fix typos

2025-02-11 00:17:43 +02:00

raft-in-scylla.md

raft: clean up the documentation

2024-12-05 13:44:11 +01:00

reader-concurrency-semaphore.md

docs: reader_concurrency_semaphore: document CPU concurrency limit

2025-03-31 09:39:55 +03:00

README.md

Add repository layout dev documentation

2025-06-25 13:58:05 +03:00

redis.md

Fix typos

2025-02-13 01:54:08 +02:00

repair_based_node_ops.md

docs/dev/repair_based_node_ops: better formatting

2023-05-25 08:31:43 +03:00

repository_layout.md

Add repository layout dev documentation

2025-06-25 13:58:05 +03:00

reverse-reads.md

reverse-reads.md: Drop legacy reverse format information

2024-08-13 10:07:12 +02:00

review-checklist.md

docs/dev: review-checklist.md: expand the guide for good commit log

2025-01-08 13:01:35 +02:00

row_cache.md

doc: Introduce docs/dev/mvcc.md

2023-01-27 19:15:39 +01:00

row_level_repair.md

Fix typos

2025-02-11 00:17:43 +02:00

rust.md

rust: use depfile and Cargo.lock to avoid building rust when unnecessary

2023-01-12 14:44:11 +02:00

secondary_index.md

docs/design-notes/secondary_index: add VALUES to index target list

2022-08-14 10:29:52 +03:00

service_levels.md

Fix typos

2025-02-11 00:17:43 +02:00

sstable-compression-dicts.md

docs/dev: add sstable-compression-dicts.md

2025-04-01 00:07:31 +02:00

sstable-scylla-format.md

Merge 'sstables: Reduce amount of I/O for clustering-key-bounded reads from large partitions' from Tomasz Grabiec

2024-10-28 21:13:23 +02:00

sstables-directory-structure.md

…

system_keyspace.md

db/system_keyspace: introduce the corrupt_data table

2025-06-24 11:05:30 +03:00

system_schema_keyspace.md

…

task_manager.md

api: task_manager: do not unregister tasks on get_status

2025-01-27 11:23:45 +01:00

testing.md

docs: update documentation with new way of running C++ tests

2025-08-06 07:25:44 +03:00

timestamp-conflict-resolution.md

docs: use less slangy language

2024-03-13 13:33:37 +02:00

tombstone.md

docs/dev/tombstone.md: fix a typo

2025-04-15 10:54:42 +03:00

topology-over-raft.md

topology coordinator: Implement global topology request queue

2025-06-11 11:29:33 +03:00

tracing.md

…

virtual-tables.md

docs: virtual-tables: Fix instructions

2025-04-09 20:21:51 +02:00

README.md

Scylla developer documentation

This folder contains developer-oriented documentation concerning the ScyllaDB codebase. We also have a wiki, which contains additional developer-oriented documentation. There is currently no clear definition of what goes where, so when looking for something be sure to check both.

Seastar documentation can be found here.

User documentation can be found on docs.scylladb.com

For information on how to build Scylla and how to contribute visit HACKING.md and CONTRIBUTING.md.

Index

Module list and dependencies

Repository layout and short summary of components