This is an automated email from the ASF dual-hosted git repository. polandll pushed a commit to branch CASS-18228-redo in repository https://gitbox.apache.org/repos/asf/cassandra.git
commit bc86656d7a987208bd4eb2334c4c3b166d9aa49c Author: Lorina Poland <[email protected]> AuthorDate: Tue Feb 28 19:19:50 2023 -0800 DOC - Reorganizing doc directories using new info arch patch by Lorina Poland; reviewed by Mick Semb Wever for CASSANDRA-18228 add installing, rename getting-started redo reorg fix merge conflict in nav.adoc --- NEWS.txt | 2 +- README.asc | 2 +- conf/cassandra.yaml | 2 +- doc/modules/ROOT/pages/index.adoc | 2 +- doc/modules/cassandra/nav.adoc | 141 ++++++++-------- .../cassandra/pages/architecture/index.adoc | 2 +- .../{storage_engine.adoc => storage-engine.adoc} | 0 .../cassandra/pages/cql/dynamic_data_masking.adoc | 178 --------------------- .../cassandra/pages/{ => developing}/cql/SASI.adoc | 0 .../pages/{ => developing}/cql/appendices.adoc | 0 .../pages/{ => developing}/cql/changes.adoc | 0 .../pages/{ => developing}/cql/cql_singlefile.adoc | 0 .../cassandra/pages/{ => developing}/cql/ddl.adoc | 0 .../pages/{ => developing}/cql/definitions.adoc | 0 .../cassandra/pages/{ => developing}/cql/dml.adoc | 0 .../pages/{ => developing}/cql/functions.adoc | 0 .../pages/{ => developing}/cql/index.adoc | 0 .../pages/{ => developing}/cql/indexes.adoc | 0 .../cassandra/pages/{ => developing}/cql/json.adoc | 0 .../cassandra/pages/{ => developing}/cql/mvs.adoc | 0 .../pages/{ => developing}/cql/operators.adoc | 0 .../pages/{ => developing}/cql/security.adoc | 0 .../pages/{ => developing}/cql/triggers.adoc | 0 .../pages/{ => developing}/cql/types.adoc | 0 .../data-modeling}/data_modeling_conceptual.adoc | 0 .../data-modeling}/data_modeling_logical.adoc | 0 .../data-modeling}/data_modeling_physical.adoc | 0 .../data-modeling}/data_modeling_queries.adoc | 0 .../data-modeling}/data_modeling_rdbms.adoc | 0 .../data-modeling}/data_modeling_refining.adoc | 0 .../data-modeling}/data_modeling_schema.adoc | 0 .../data-modeling}/data_modeling_tools.adoc | 0 .../data-modeling}/images/Figure_1_data_model.jpg | Bin .../data-modeling}/images/Figure_2_data_model.jpg | Bin .../images/data_modeling_chebotko_logical.png | Bin .../images/data_modeling_chebotko_physical.png | Bin .../images/data_modeling_hotel_bucketing.png | Bin .../images/data_modeling_hotel_erd.png | Bin .../images/data_modeling_hotel_logical.png | Bin .../images/data_modeling_hotel_physical.png | Bin .../images/data_modeling_hotel_queries.png | Bin .../images/data_modeling_hotel_relational.png | Bin .../images/data_modeling_reservation_logical.png | Bin .../images/data_modeling_reservation_physical.png | Bin .../data-modeling}/index.adoc | 0 .../data-modeling}/intro.adoc | 0 .../configuring.adoc | 0 .../drivers.adoc | 0 .../cassandra/pages/getting-started/index.adoc | 30 ++++ .../production.adoc | 0 .../querying.adoc | 2 +- .../quickstart.adoc | 0 .../cassandra/pages/getting_started/index.adoc | 30 ---- .../installing.adoc | 4 +- .../pages/{ => integrating}/plugins/index.adoc | 0 .../configuration/cass_cl_archive_file.adoc | 0 .../configuration/cass_env_sh_file.adoc | 0 .../configuration/cass_jvm_options_file.adoc | 0 .../configuration/cass_logback_xml_file.adoc | 0 .../configuration/cass_rackdc_file.adoc | 0 .../configuration/cass_topo_file.adoc | 0 .../configuration/configuration.adoc | 0 .../pages/{ => managing}/configuration/index.adoc | 0 .../{ => managing}/operating/audit_logging.adoc | 0 .../{ => managing}/operating/auditlogging.adoc | 0 .../pages/{ => managing}/operating/backups.adoc | 0 .../{ => managing}/operating/bloom_filters.adoc | 0 .../{ => managing}/operating/bulk_loading.adoc | 0 .../pages/{ => managing}/operating/cdc.adoc | 0 .../{ => managing}/operating/compaction/index.adoc | 0 .../{ => managing}/operating/compaction/lcs.adoc | 0 .../{ => managing}/operating/compaction/stcs.adoc | 0 .../{ => managing}/operating/compaction/twcs.adoc | 0 .../{ => managing}/operating/compression.adoc | 0 .../operating/denylisting_partitions.adoc | 0 .../pages/{ => managing}/operating/fqllogging.adoc | 0 .../pages/{ => managing}/operating/hardware.adoc | 0 .../pages/{ => managing}/operating/hints.adoc | 0 .../pages/{ => managing}/operating/index.adoc | 0 .../pages/{ => managing}/operating/metrics.adoc | 0 .../{ => managing}/operating/read_repair.adoc | 0 .../pages/{ => managing}/operating/repair.adoc | 0 .../pages/{ => managing}/operating/security.adoc | 0 .../{ => managing}/operating/topo_changes.adoc | 0 .../operating/transientreplication.adoc | 0 .../{ => managing}/operating/virtualtables.adoc | 0 .../{ => managing}/tools/cassandra_stress.adoc | 0 .../pages/{ => managing}/tools/cqlsh.adoc | 0 .../pages/{ => managing}/tools/hash_password.adoc | 0 .../pages/{ => managing}/tools/index.adoc | 0 .../pages/{ => managing}/tools/sstable/index.adoc | 0 .../{ => managing}/tools/sstable/sstabledump.adoc | 0 .../tools/sstable/sstableexpiredblockers.adoc | 0 .../tools/sstable/sstablelevelreset.adoc | 0 .../tools/sstable/sstableloader.adoc | 0 .../tools/sstable/sstablemetadata.adoc | 0 .../tools/sstable/sstableofflinerelevel.adoc | 0 .../tools/sstable/sstablerepairedset.adoc | 0 .../{ => managing}/tools/sstable/sstablescrub.adoc | 0 .../{ => managing}/tools/sstable/sstablesplit.adoc | 0 .../tools/sstable/sstableupgrade.adoc | 0 .../{ => managing}/tools/sstable/sstableutil.adoc | 0 .../tools/sstable/sstableverify.adoc | 0 .../pages/{new => managing}/virtualtables.adoc | 0 doc/modules/cassandra/pages/new/4.1-new.adoc | 20 +++ doc/modules/cassandra/pages/new/4.2-new.adoc | 12 ++ .../cassandra/pages/{ => overview}/faq/index.adoc | 0 .../cassandra/pages/overview/terminology.adoc | 23 +++ .../{getting_started => references}/java11.adoc | 0 .../cassandra/pages/tooling/cass-stress-deprecated | 0 .../cassandra/pages/tooling/generate-tokens | 0 .../cassandra/pages/tooling/hash-password-tool | 0 .../cassandra/partials/nodetool_and_cqlsh.adoc | 2 +- .../partials/nodetool_and_cqlsh_nobin.adoc | 2 +- 114 files changed, 165 insertions(+), 289 deletions(-) diff --git a/NEWS.txt b/NEWS.txt index 848a0fa5ef..67b02bf87b 100644 --- a/NEWS.txt +++ b/NEWS.txt @@ -663,7 +663,7 @@ Upgrading the node will not start. See CASSANDRA-14477 for details. - CASSANDRA-13701 To give a better out of the box experience, the default 'num_tokens' value has been changed from 256 to 16 for reasons described in - https://cassandra.apache.org/doc/latest/getting_started/production.html#tokens + https://cassandra.apache.org/doc/latest/getting-started/production.html#tokens 'allocate_tokens_for_local_replication_factor' is also uncommented and set to 3. Please note when upgrading that if the 'num_tokens' value is different than what you have configured, the upgraded node will refuse to start. Also note that if a new node joining diff --git a/README.asc b/README.asc index a2101a6e3a..16d5e09738 100644 --- a/README.asc +++ b/README.asc @@ -20,7 +20,7 @@ Getting started --------------- This short guide will walk you through getting a basic one node cluster up -and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's http://cassandra.apache.org/doc/latest/getting_started/[Getting Started Guide]. +and running, and demonstrate some simple reads and writes. For a more-complete guide, please see the Apache Cassandra website's http://cassandra.apache.org/doc/latest/getting-started/[Getting Started Guide]. First, we'll unpack our archive: diff --git a/conf/cassandra.yaml b/conf/cassandra.yaml index ee616e1674..a6f8c84a6f 100644 --- a/conf/cassandra.yaml +++ b/conf/cassandra.yaml @@ -21,7 +21,7 @@ cluster_name: 'Test Cluster' # Specifying initial_token will override this setting on the node's initial start, # on subsequent starts, this setting will apply even if initial token is set. # -# See https://cassandra.apache.org/doc/latest/getting_started/production.html#tokens for +# See https://cassandra.apache.org/doc/latest/getting-started/production.html#tokens for # best practice information about num_tokens. # num_tokens: 16 diff --git a/doc/modules/ROOT/pages/index.adoc b/doc/modules/ROOT/pages/index.adoc index b4e8f650e6..b916144376 100644 --- a/doc/modules/ROOT/pages/index.adoc +++ b/doc/modules/ROOT/pages/index.adoc @@ -15,7 +15,7 @@ to do so by submitting your contribution like any other patch following [cols="a,a"] |=== -| xref:cassandra:getting_started/index.adoc[Getting started] | Newbie starting point +| xref:cassandra:getting-started/index.adoc[Getting started] | Newbie starting point | xref:cassandra:new/index.adoc[What's new in 5.0] | What's new in Cassandra 5.0 diff --git a/doc/modules/cassandra/nav.adoc b/doc/modules/cassandra/nav.adoc index 9c671a2a6d..ff8e676a69 100644 --- a/doc/modules/cassandra/nav.adoc +++ b/doc/modules/cassandra/nav.adoc @@ -1,87 +1,86 @@ * Cassandra -** xref:getting_started/index.adoc[Getting Started] -*** xref:getting_started/installing.adoc[Installing Cassandra] -*** xref:getting_started/configuring.adoc[Configuring Cassandra] -*** xref:getting_started/querying.adoc[Inserting and querying] -*** xref:getting_started/drivers.adoc[Client drivers] -*** xref:getting_started/java11.adoc[Support for Java 11] -*** xref:getting_started/production.adoc[Production recommendations] +** xref:getting-started/index.adoc[Getting Started] +*** xref:installing/installing.adoc[Installing Cassandra] +*** xref:getting-started/configuring.adoc[Configuring Cassandra] +*** xref:getting-started/querying.adoc[Inserting and querying] +*** xref:getting-started/drivers.adoc[Client drivers] +*** xref:getting-started/java11.adoc[Support for Java 11] +*** xref:getting-started/production.adoc[Production recommendations] ** xref:new/index.adoc[What's new] ** xref:architecture/index.adoc[Architecture] *** xref:architecture/overview.adoc[Overview] *** xref:architecture/dynamo.adoc[Dynamo] -*** xref:architecture/storage_engine.adoc[Storage engine] +*** xref:architecture/storage-engine.adoc[Storage engine] *** xref:architecture/guarantees.adoc[Guarantees] *** xref:architecture/messaging.adoc[Improved internode messaging] *** xref:architecture/streaming.adoc[Improved streaming] -** xref:data_modeling/index.adoc[Data modeling] -*** xref:data_modeling/intro.adoc[Introduction] -*** xref:data_modeling/data_modeling_conceptual.adoc[Conceptual data modeling] -*** xref:data_modeling/data_modeling_rdbms.adoc[RDBMS design] -*** xref:data_modeling/data_modeling_queries.adoc[Defining application queries] -*** xref:data_modeling/data_modeling_logical.adoc[Logical data modeling] -*** xref:data_modeling/data_modeling_physical.adoc[Physical data modeling] -*** xref:data_modeling/data_modeling_refining.adoc[Evaluating and refining data models] -*** xref:data_modeling/data_modeling_schema.adoc[Defining database schema] -*** xref:data_modeling/data_modeling_tools.adoc[Cassandra data modeling tools] +** xref:developing:data_modeling/index.adoc[Data modeling] +*** xref:developing:data_modeling/intro.adoc[Introduction] +*** xref:developing:data_modeling/data_modeling_conceptual.adoc[Conceptual data modeling] +*** xref:developing:data_modeling/data_modeling_rdbms.adoc[RDBMS design] +*** xref:developing:data_modeling/data_modeling_queries.adoc[Defining application queries] +*** xref:developing:data_modeling/data_modeling_logical.adoc[Logical data modeling] +*** xref:developing:data_modeling/data_modeling_physical.adoc[Physical data modeling] +*** xref:developing:data_modeling/data_modeling_refining.adoc[Evaluating and refining data models] +*** xref:developing:data_modeling/data_modeling_schema.adoc[Defining database schema] +*** xref:developing:data_modeling/data_modeling_tools.adoc[Cassandra data modeling tools] -** xref:cql/index.adoc[Cassandra Query Language (CQL)] -*** xref:cql/definitions.adoc[Definitions] -*** xref:cql/types.adoc[Data types] -*** xref:cql/ddl.adoc[Data definition (DDL)] -*** xref:cql/dml.adoc[Data manipulation (DML)] -*** xref:cql/operators.adoc[Operators] -*** xref:cql/indexes.adoc[Secondary indexes] -*** xref:cql/mvs.adoc[Materialized views] -*** xref:cql/functions.adoc[Functions] -*** xref:cql/json.adoc[JSON] -*** xref:cql/security.adoc[Security] -*** xref:cql/dynamic_data_masking.adoc[Dynamic data masking] -*** xref:cql/triggers.adoc[Triggers] -*** xref:cql/appendices.adoc[Appendices] -*** xref:cql/changes.adoc[Changes] -*** xref:cql/SASI.adoc[SASI] -*** xref:cql/cql_singlefile.adoc[Single file of CQL information] +** xref:developing:cql/index.adoc[Cassandra Query Language (CQL)] +*** xref:developing:cql/definitions.adoc[Definitions] +*** xref:developing:cql/types.adoc[Data types] +*** xref:developing:cql/ddl.adoc[Data definition (DDL)] +*** xref:developing:cql/dml.adoc[Data manipulation (DML)] +*** xref:developing:cql/operators.adoc[Operators] +*** xref:developing:cql/indexes.adoc[Secondary indexes] +*** xref:developing:cql/mvs.adoc[Materialized views] +*** xref:developing:cql/functions.adoc[Functions] +*** xref:developing:cql/json.adoc[JSON] +*** xref:developing:cql/security.adoc[Security] +*** xref:developing:cql/triggers.adoc[Triggers] +*** xref:developing:cql/appendices.adoc[Appendices] +*** xref:developing:cql/changes.adoc[Changes] +*** xref:developing:cql/SASI.adoc[SASI] +*** xref:developing:cql/cql_singlefile.adoc[Single file of CQL information] -** xref:configuration/index.adoc[Configuration] -*** xref:configuration/cass_yaml_file.adoc[cassandra.yaml] -*** xref:configuration/cass_rackdc_file.adoc[cassandra-rackdc.properties] -*** xref:configuration/cass_env_sh_file.adoc[cassandra-env.sh] -*** xref:configuration/cass_topo_file.adoc[cassandra-topologies.properties] -*** xref:configuration/cass_cl_archive_file.adoc[commitlog-archiving.properties] -*** xref:configuration/cass_logback_xml_file.adoc[logback.xml] -*** xref:configuration/cass_jvm_options_file.adoc[jvm-* files] -*** xref:configuration/configuration.adoc[Liberating cassandra.yaml Parameters' Names from Their Units] +** xref:managing:configuration/index.adoc[Configuration] +*** xref:managing:configuration/cass_yaml_file.adoc[cassandra.yaml] +*** xref:managing:configuration/cass_rackdc_file.adoc[cassandra-rackdc.properties] +*** xref:managing:configuration/cass_env_sh_file.adoc[cassandra-env.sh] +*** xref:managing:configuration/cass_topo_file.adoc[cassandra-topologies.properties] +*** xref:managing:configuration/cass_cl_archive_file.adoc[commitlog-archiving.properties] +*** xref:managing:configuration/cass_logback_xml_file.adoc[logback.xml] +*** xref:managing:configuration/cass_jvm_options_file.adoc[jvm-* files] +*** xref:managing:configuration/configuration.adoc[Liberating cassandra.yaml Parameters' Names from Their Units] -** xref:operating/index.adoc[Operating] -*** xref:operating/snitch.adoc[Snitches] -*** xref:operating/topo_changes.adoc[Topology changes] -*** xref:operating/repair.adoc[Repair] -*** xref:operating/read_repair.adoc[Read repair] -*** xref:operating/hints.adoc[Hints] -*** xref:operating/bloom_filters.adoc[Bloom filters] -*** xref:operating/compression.adoc[Compression] -*** xref:operating/cdc.adoc[Change Data Capture (CDC)] -*** xref:operating/backups.adoc[Backups] -*** xref:operating/bulk_loading.adoc[Bulk loading] -*** xref:operating/metrics.adoc[Metrics] -*** xref:operating/security.adoc[Security] -*** xref:operating/hardware.adoc[Hardware] -*** xref:operating/compaction/index.adoc[Compaction] -*** xref:operating/virtualtables.adoc[Virtual tables] -*** xref:operating/auditlogging.adoc[Audit logging] -*** xref:operating/audit_logging.adoc[Audit logging 2] -*** xref:operating/fqllogging.adoc[Full query logging] -*** xref:operating/transientreplication.adoc[Transient replication] +** xref:managing:operating/index.adoc[Operating] +*** xref:managing:operating/snitch.adoc[Snitches] +*** xref:managing:operating/topo_changes.adoc[Topology changes] +*** xref:managing:operating/repair.adoc[Repair] +*** xref:managing:operating/read_repair.adoc[Read repair] +*** xref:managing:operating/hints.adoc[Hints] +*** xref:managing:operating/bloom_filters.adoc[Bloom filters] +*** xref:managing:operating/compression.adoc[Compression] +*** xref:managing:operating/cdc.adoc[Change Data Capture (CDC)] +*** xref:managing:operating/backups.adoc[Backups] +*** xref:managing:operating/bulk_loading.adoc[Bulk loading] +*** xref:managing:operating/metrics.adoc[Metrics] +*** xref:managing:operating/security.adoc[Security] +*** xref:managing:operating/hardware.adoc[Hardware] +*** xref:managing:operating/compaction/index.adoc[Compaction] +*** xref:managing:operating/virtualtables.adoc[Virtual tables] +*** xref:managing:operating/auditlogging.adoc[Audit logging] +*** xref:managing:operating/audit_logging.adoc[Audit logging 2] +*** xref:managing:operating/fqllogging.adoc[Full query logging] +*** xref:managing:operating/transientreplication.adoc[Transient replication] -** xref:tools/index.adoc[Tools] -*** xref:tools/cqlsh.adoc[cqlsh: the CQL shell] -*** xref:tools/nodetool/nodetool.adoc[nodetool] -*** xref:tools/sstable/index.adoc[SSTable tools] -*** xref:tools/cassandra_stress.adoc[cassandra-stress] +** xref:managing:tools/index.adoc[Tools] +*** xref:managing:tools/cqlsh.adoc[cqlsh: the CQL shell] +*** xref:managing:tools/nodetool/nodetool.adoc[nodetool] +*** xref:managing:tools/sstable/index.adoc[SSTable tools] +*** xref:managing:tools/cassandra_stress.adoc[cassandra-stress] ** xref:troubleshooting/index.adoc[Troubleshooting] *** xref:troubleshooting/finding_nodes.adoc[Finding misbehaving nodes] @@ -102,7 +101,7 @@ *** xref:master@_:ROOT:development/dependencies.adoc[Dependency management] *** xref:master@_:ROOT:development/release_process.adoc[Release process] -** xref:faq/index.adoc[FAQ] +** xref:overview:faq/index.adoc[FAQ] -** xref:plugins/index.adoc[Plug-ins] +** xref:integrating:plugins/index.adoc[Plug-ins] diff --git a/doc/modules/cassandra/pages/architecture/index.adoc b/doc/modules/cassandra/pages/architecture/index.adoc index c4bef05cfd..9e674d95a2 100644 --- a/doc/modules/cassandra/pages/architecture/index.adoc +++ b/doc/modules/cassandra/pages/architecture/index.adoc @@ -4,6 +4,6 @@ This section describes the general architecture of Apache Cassandra. * xref:architecture/overview.adoc[Overview] * xref:architecture/dynamo.adoc[Dynamo] -* xref:architecture/storage_engine.adoc[Storage Engine] +* xref:architecture/storage-engine.adoc[Storage Engine] * xref:architecture/guarantees.adoc[Guarantees] * xref:architecture/snitch.adoc[Snitches] diff --git a/doc/modules/cassandra/pages/architecture/storage_engine.adoc b/doc/modules/cassandra/pages/architecture/storage-engine.adoc similarity index 100% rename from doc/modules/cassandra/pages/architecture/storage_engine.adoc rename to doc/modules/cassandra/pages/architecture/storage-engine.adoc diff --git a/doc/modules/cassandra/pages/cql/dynamic_data_masking.adoc b/doc/modules/cassandra/pages/cql/dynamic_data_masking.adoc deleted file mode 100644 index ef2453e352..0000000000 --- a/doc/modules/cassandra/pages/cql/dynamic_data_masking.adoc +++ /dev/null @@ -1,178 +0,0 @@ -= Dynamic Data Masking - -Dynamic data masking (DDM) allows to obscure sensitive information while still allowing access to the masked columns. -DDM doesn't change the stored data. Instead, it just presents the data on their obscured form during `SELECT` queries. -This aims to provide some degree of protection against accidental data exposure. However, it's important to know that -anyone with direct access to the sstable files will be able to read the clear data. - -== Masking functions - -DDM is based on a set of CQL native functions that obscure sensitive information. The available functions are: - -include::partial$masking_functions.adoc[] - -Those functions can be discretionarily used on `SELECT` queries to get an obscured view of the data. For example: - -[source,cql] ----- -include::example$CQL/select_with_mask_functions.cql[] ----- - -== Attaching masking functions to table columns - -The masking functions can be permanently attached to the columns of a table. -In that case, `SELECT` queries will always return the column values in their masked form. -The masking will be transparent for the users running `SELECT` queries, -so their only way to know that a column is masked will be consulting the table definition. - -This is an optional feature that should be enabled with the `dynamic_data_masking_enabled` property in `cassandra.yaml`, -since it's disabled by default. - -The masks of the columns of a table can be defined on `CREATE TABLE` queries: - -[source,cql] ----- -include::example$CQL/ddm_create_table.cql[] ----- - -Note that in the example above we are referencing the `mask_inner` function with two arguments. -However, that CQL function actually has three arguments when explicitely used on `SELECT` queries. -The first argument is always ommitted when attaching the function to a schema column. -The value of that first argument is always interpreted as the value of the masked column, in this case a `text` column. -For the same reason the call to `mask_default` attached to the column doesn't have any argument, -even when that function requires one argument when explicitely used on `SELECT` queries. - -Data can be inserted into the masked table as usual. For example: - -[source,cql] ----- -include::example$CQL/ddm_insert_data.cql[] ----- - -The attached column masks will make `SELECT` queries automatically return masked data, -without the need of including the masking function on the query: - -[source,cql] ----- -include::example$CQL/ddm_select_with_masked_columns.cql[] ----- - -The masking function attached to a column can be changed with an `ALTER TABLE` query: - -[source,cql] ----- -include::example$CQL/ddm_alter_mask.cql[] ----- - -In a similar way, a masking function can be dettached from a column with an `ALTER TABLE` query: - -[source,cql] ----- -include::example$CQL/ddm_drop_mask.cql[] ----- - -== Permissions - -The `UNMASK` permission allows users to retrieve the unmasked values of masked columns. -The masks will only be applied to the results of a `SELECT` query if the user doesn't have the `UNMASK` permission. -Ordinary users are created without the `UNMASK` permission, whereas superusers do have it. - -As an example, suppose that we have a table with masked columns: - -[source,cql] ----- -include::example$CQL/ddm_create_table.cql[] ----- - -And we insert some data into the table: - -[source,cql] ----- -include::example$CQL/ddm_insert_data.cql[] ----- - -[source,cql] ----- -include::example$CQL/ddm_select_without_unmask_permission.cql[] ----- - -Then we create two users with `SELECT` permission for the table, but we only grant the `UNMASK` permission to one of -the users: - -[source,cql] ----- -include::example$CQL/ddm_create_users.cql[] ----- - -We can now see that the user with the `UNMASK` permission can see the clear data, without any masking: - -[source,cql] ----- -include::example$CQL/ddm_select_with_unmask_permission.cql[] ----- - -However, the user without the `UNMASK` permission can only see the masked data: - -[source,cql] ----- -include::example$CQL/ddm_select_without_unmask_permission.cql[] ----- - -The `UNMASK` permission works as any other permission. Thus, it can be revoked in any moment: - -[source,cql] ----- -include::example$CQL/ddm_revoke_unmask.cql[] ----- - -Please note that the anonymous user that is used when authentication is disabled has all the permissions. -Since it includes the `UNMASK` permission, that anonymous user will always see the clear data. -In other words, attaching data masking functions to columns only makes sense if authentication is enabled. - -Users without the `UNMASK` permission are not allowed to use masked columns in the `WHERE` clause of a `SELECT` query. -This prevents malicious users from figuring out the clear data by running exhaustive queries. For instance: - -[source,cql] ----- -include::example$CQL/ddm_select_without_select_masked.cql[] ----- - -However, there are some use cases where trusted database users just need a useful way to produce masked data -that will be served to untrusted external users. -For example, a trusted app can connect to the database and extract masked data that will be served to its end users. -In that case the trusted user (the app) can be given the `SELECT_MASKED` permission. -That permission allows to use masked columns in the `WHERE` clause of a `SELECT` query, -while still seeing the masked data in the query results. For instance: - -[source,cql] ----- -include::example$CQL/ddm_select_with_select_masked.cql[] ----- - -== Custom functions - -xref:cql/functions.adoc#user-defined-scalar-functions[User-defined functions (UDFs)] can be attached to a table column. -The UDFs used for masking should belong to the same keyspace as the masked table. -The column value to mask will be passed as the first argument of the attached UDF. -Thus, the UDFs attached to a column should have at least one argument, -and that argument should have the same type as the masked column. -Also, the attached UDF should return values of the same type as the maked column. For instance: - -[source,cql] ----- -include::example$CQL/ddm_create_table_with_udf.cql[] ----- - -This creates a dependency between the table schema and the functions. -Any attempt to drop the function will be rejected while this dependency exists. -Thus, to drop the function you should first drop the mask. -This can be done with: - -[source,cql] ----- -include::example$CQL/ddm_drop_mask.cql[] ----- - -Dropping the column, or its containing table, or its containing keyspace would also remove the dependency. - -xref:cql/functions.adoc#aggregate-functions[Aggregate functions] cannot be used as masking functions. \ No newline at end of file diff --git a/doc/modules/cassandra/pages/cql/SASI.adoc b/doc/modules/cassandra/pages/developing/cql/SASI.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/SASI.adoc rename to doc/modules/cassandra/pages/developing/cql/SASI.adoc diff --git a/doc/modules/cassandra/pages/cql/appendices.adoc b/doc/modules/cassandra/pages/developing/cql/appendices.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/appendices.adoc rename to doc/modules/cassandra/pages/developing/cql/appendices.adoc diff --git a/doc/modules/cassandra/pages/cql/changes.adoc b/doc/modules/cassandra/pages/developing/cql/changes.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/changes.adoc rename to doc/modules/cassandra/pages/developing/cql/changes.adoc diff --git a/doc/modules/cassandra/pages/cql/cql_singlefile.adoc b/doc/modules/cassandra/pages/developing/cql/cql_singlefile.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/cql_singlefile.adoc rename to doc/modules/cassandra/pages/developing/cql/cql_singlefile.adoc diff --git a/doc/modules/cassandra/pages/cql/ddl.adoc b/doc/modules/cassandra/pages/developing/cql/ddl.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/ddl.adoc rename to doc/modules/cassandra/pages/developing/cql/ddl.adoc diff --git a/doc/modules/cassandra/pages/cql/definitions.adoc b/doc/modules/cassandra/pages/developing/cql/definitions.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/definitions.adoc rename to doc/modules/cassandra/pages/developing/cql/definitions.adoc diff --git a/doc/modules/cassandra/pages/cql/dml.adoc b/doc/modules/cassandra/pages/developing/cql/dml.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/dml.adoc rename to doc/modules/cassandra/pages/developing/cql/dml.adoc diff --git a/doc/modules/cassandra/pages/cql/functions.adoc b/doc/modules/cassandra/pages/developing/cql/functions.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/functions.adoc rename to doc/modules/cassandra/pages/developing/cql/functions.adoc diff --git a/doc/modules/cassandra/pages/cql/index.adoc b/doc/modules/cassandra/pages/developing/cql/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/index.adoc rename to doc/modules/cassandra/pages/developing/cql/index.adoc diff --git a/doc/modules/cassandra/pages/cql/indexes.adoc b/doc/modules/cassandra/pages/developing/cql/indexes.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/indexes.adoc rename to doc/modules/cassandra/pages/developing/cql/indexes.adoc diff --git a/doc/modules/cassandra/pages/cql/json.adoc b/doc/modules/cassandra/pages/developing/cql/json.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/json.adoc rename to doc/modules/cassandra/pages/developing/cql/json.adoc diff --git a/doc/modules/cassandra/pages/cql/mvs.adoc b/doc/modules/cassandra/pages/developing/cql/mvs.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/mvs.adoc rename to doc/modules/cassandra/pages/developing/cql/mvs.adoc diff --git a/doc/modules/cassandra/pages/cql/operators.adoc b/doc/modules/cassandra/pages/developing/cql/operators.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/operators.adoc rename to doc/modules/cassandra/pages/developing/cql/operators.adoc diff --git a/doc/modules/cassandra/pages/cql/security.adoc b/doc/modules/cassandra/pages/developing/cql/security.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/security.adoc rename to doc/modules/cassandra/pages/developing/cql/security.adoc diff --git a/doc/modules/cassandra/pages/cql/triggers.adoc b/doc/modules/cassandra/pages/developing/cql/triggers.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/triggers.adoc rename to doc/modules/cassandra/pages/developing/cql/triggers.adoc diff --git a/doc/modules/cassandra/pages/cql/types.adoc b/doc/modules/cassandra/pages/developing/cql/types.adoc similarity index 100% rename from doc/modules/cassandra/pages/cql/types.adoc rename to doc/modules/cassandra/pages/developing/cql/types.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_conceptual.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_conceptual.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_conceptual.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_conceptual.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_logical.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_logical.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_logical.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_logical.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_physical.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_physical.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_physical.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_physical.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_queries.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_queries.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_queries.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_queries.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_rdbms.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_rdbms.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_rdbms.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_rdbms.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_refining.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_refining.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_refining.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_refining.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_schema.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_schema.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_schema.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_schema.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/data_modeling_tools.adoc b/doc/modules/cassandra/pages/developing/data-modeling/data_modeling_tools.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/data_modeling_tools.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/data_modeling_tools.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/images/Figure_1_data_model.jpg b/doc/modules/cassandra/pages/developing/data-modeling/images/Figure_1_data_model.jpg similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/Figure_1_data_model.jpg rename to doc/modules/cassandra/pages/developing/data-modeling/images/Figure_1_data_model.jpg diff --git a/doc/modules/cassandra/pages/data_modeling/images/Figure_2_data_model.jpg b/doc/modules/cassandra/pages/developing/data-modeling/images/Figure_2_data_model.jpg similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/Figure_2_data_model.jpg rename to doc/modules/cassandra/pages/developing/data-modeling/images/Figure_2_data_model.jpg diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_chebotko_logical.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_chebotko_logical.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_chebotko_logical.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_chebotko_logical.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_chebotko_physical.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_chebotko_physical.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_chebotko_physical.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_chebotko_physical.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_bucketing.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_bucketing.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_bucketing.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_bucketing.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_erd.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_erd.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_erd.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_erd.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_logical.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_logical.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_logical.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_logical.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_physical.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_physical.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_physical.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_physical.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_queries.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_queries.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_queries.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_queries.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_relational.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_relational.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_hotel_relational.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_hotel_relational.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_reservation_logical.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_reservation_logical.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_reservation_logical.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_reservation_logical.png diff --git a/doc/modules/cassandra/pages/data_modeling/images/data_modeling_reservation_physical.png b/doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_reservation_physical.png similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/images/data_modeling_reservation_physical.png rename to doc/modules/cassandra/pages/developing/data-modeling/images/data_modeling_reservation_physical.png diff --git a/doc/modules/cassandra/pages/data_modeling/index.adoc b/doc/modules/cassandra/pages/developing/data-modeling/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/index.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/index.adoc diff --git a/doc/modules/cassandra/pages/data_modeling/intro.adoc b/doc/modules/cassandra/pages/developing/data-modeling/intro.adoc similarity index 100% rename from doc/modules/cassandra/pages/data_modeling/intro.adoc rename to doc/modules/cassandra/pages/developing/data-modeling/intro.adoc diff --git a/doc/modules/cassandra/pages/getting_started/configuring.adoc b/doc/modules/cassandra/pages/getting-started/configuring.adoc similarity index 100% rename from doc/modules/cassandra/pages/getting_started/configuring.adoc rename to doc/modules/cassandra/pages/getting-started/configuring.adoc diff --git a/doc/modules/cassandra/pages/getting_started/drivers.adoc b/doc/modules/cassandra/pages/getting-started/drivers.adoc similarity index 100% rename from doc/modules/cassandra/pages/getting_started/drivers.adoc rename to doc/modules/cassandra/pages/getting-started/drivers.adoc diff --git a/doc/modules/cassandra/pages/getting-started/index.adoc b/doc/modules/cassandra/pages/getting-started/index.adoc new file mode 100644 index 0000000000..3d3c823c26 --- /dev/null +++ b/doc/modules/cassandra/pages/getting-started/index.adoc @@ -0,0 +1,30 @@ += Getting Started + +This section covers how to get started using Apache Cassandra and should +be the first thing to read if you are new to Cassandra. + +* xref:installing/installing.adoc[Installing Cassandra]: Installation instructions plus information on choosing a method. +** [ xref:installing/installing.adoc#installing-the-docker-image[Docker] ] +[ xref:installing/installing.adoc#installing-the-binary-tarball[tarball] ] +[ xref:installing/installing.adoc#installing-the-debian-packages[Debian] ] +[ xref:installing/installing.adoc#installing-the-rpm-packages[RPM] ] +* xref:getting-started/configuring.adoc[Configuring Cassandra] +* xref:getting-started/querying.adoc[Inserting and querying data] +* xref:getting-started/drivers.adoc[Client drivers]: Drivers for various languages. +** [ xref:getting-started/drivers.adoc#java[Java] ] + [ xref:getting-started/drivers.adoc#python[Python] ] + [ xref:getting-started/drivers.adoc#ruby[Ruby] ] + [ xref:getting-started/drivers.adoc#c-net[C# / .NET] ] + [ xref:getting-started/drivers.adoc#nodejs[Node.js] ] + [ xref:getting-started/drivers.adoc#php[PHP] ] + [ xref:getting-started/drivers.adoc#c[C++] ] + [ xref:getting-started/drivers.adoc#scala[Scala] ] + [ xref:getting-started/drivers.adoc#clojure[Clojure] ] + [ xref:getting-started/drivers.adoc#erlang[Erlang] ] + [ xref:getting-started/drivers.adoc#go[Go] ] + [ xref:getting-started/drivers.adoc#haskell[Haskell] ] + [ xref:getting-started/drivers.adoc#rust[Rust] ] + [ xref:getting-started/drivers.adoc#perl[Perl] ] + [ xref:getting-started/drivers.adoc#elixir[Elixir] ] + [ xref:getting-started/drivers.adoc#dart[Dart] ] +* xref:getting-started/production.adoc[Production recommendations] diff --git a/doc/modules/cassandra/pages/getting_started/production.adoc b/doc/modules/cassandra/pages/getting-started/production.adoc similarity index 100% rename from doc/modules/cassandra/pages/getting_started/production.adoc rename to doc/modules/cassandra/pages/getting-started/production.adoc diff --git a/doc/modules/cassandra/pages/getting_started/querying.adoc b/doc/modules/cassandra/pages/getting-started/querying.adoc similarity index 94% rename from doc/modules/cassandra/pages/getting_started/querying.adoc rename to doc/modules/cassandra/pages/getting-started/querying.adoc index a8b348a06c..e0a6d6fdc3 100644 --- a/doc/modules/cassandra/pages/getting_started/querying.adoc +++ b/doc/modules/cassandra/pages/getting-started/querying.adoc @@ -26,6 +26,6 @@ If the command is used without specifying a node, `localhost` is the default. Se == Client drivers -A lot of xref:getting_started/drivers.adoc[client drivers] are provided by the Community and a list of +A lot of xref:getting-started/drivers.adoc[client drivers] are provided by the Community and a list of known drivers is provided. You should refer to the documentation of each driver for more information. diff --git a/doc/modules/cassandra/pages/getting_started/quickstart.adoc b/doc/modules/cassandra/pages/getting-started/quickstart.adoc similarity index 100% rename from doc/modules/cassandra/pages/getting_started/quickstart.adoc rename to doc/modules/cassandra/pages/getting-started/quickstart.adoc diff --git a/doc/modules/cassandra/pages/getting_started/index.adoc b/doc/modules/cassandra/pages/getting_started/index.adoc deleted file mode 100644 index af43c17a0b..0000000000 --- a/doc/modules/cassandra/pages/getting_started/index.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Getting Started - -This section covers how to get started using Apache Cassandra and should -be the first thing to read if you are new to Cassandra. - -* xref:getting_started/installing.adoc[Installing Cassandra]: Installation instructions plus information on choosing a method. -** [ xref:getting_started/installing.adoc#installing-the-docker-image[Docker] ] -[ xref:getting_started/installing.adoc#installing-the-binary-tarball[tarball] ] -[ xref:getting_started/installing.adoc#installing-the-debian-packages[Debian] ] -[ xref:getting_started/installing.adoc#installing-the-rpm-packages[RPM] ] -* xref:getting_started/configuring.adoc[Configuring Cassandra] -* xref:getting_started/querying.adoc[Inserting and querying data] -* xref:getting_started/drivers.adoc[Client drivers]: Drivers for various languages. -** [ xref:getting_started/drivers.adoc#java[Java] ] - [ xref:getting_started/drivers.adoc#python[Python] ] - [ xref:getting_started/drivers.adoc#ruby[Ruby] ] - [ xref:getting_started/drivers.adoc#c-net[C# / .NET] ] - [ xref:getting_started/drivers.adoc#nodejs[Node.js] ] - [ xref:getting_started/drivers.adoc#php[PHP] ] - [ xref:getting_started/drivers.adoc#c[C++] ] - [ xref:getting_started/drivers.adoc#scala[Scala] ] - [ xref:getting_started/drivers.adoc#clojure[Clojure] ] - [ xref:getting_started/drivers.adoc#erlang[Erlang] ] - [ xref:getting_started/drivers.adoc#go[Go] ] - [ xref:getting_started/drivers.adoc#haskell[Haskell] ] - [ xref:getting_started/drivers.adoc#rust[Rust] ] - [ xref:getting_started/drivers.adoc#perl[Perl] ] - [ xref:getting_started/drivers.adoc#elixir[Elixir] ] - [ xref:getting_started/drivers.adoc#dart[Dart] ] -* xref:getting_started/production.adoc[Production recommendations] diff --git a/doc/modules/cassandra/pages/getting_started/installing.adoc b/doc/modules/cassandra/pages/installing/installing.adoc similarity index 98% rename from doc/modules/cassandra/pages/getting_started/installing.adoc rename to doc/modules/cassandra/pages/installing/installing.adoc index c8ddcd0095..90c308985e 100644 --- a/doc/modules/cassandra/pages/getting_started/installing.adoc +++ b/doc/modules/cassandra/pages/installing/installing.adoc @@ -189,7 +189,7 @@ include::example$TEXT/tarball_install_dirs.txt[] <5>location of cassandra-stress tool For information on how to configure your installation, see -{cass_url}doc/latest/getting_started/configuring.html[Configuring +{cass_url}doc/latest/getting-started/configuring.html[Configuring Cassandra]. [arabic, start=6] @@ -286,7 +286,7 @@ include::example$BASH/apt-get_cass.sh[] ---- NOTE: For information on how to configure your installation, see -{cass_url}doc/latest/getting_started/configuring.html[Configuring +{cass_url}doc/latest/getting-started/configuring.html[Configuring Cassandra]. include::partial$tail_syslog.adoc[] diff --git a/doc/modules/cassandra/pages/plugins/index.adoc b/doc/modules/cassandra/pages/integrating/plugins/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/plugins/index.adoc rename to doc/modules/cassandra/pages/integrating/plugins/index.adoc diff --git a/doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc b/doc/modules/cassandra/pages/managing/configuration/cass_cl_archive_file.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/cass_cl_archive_file.adoc rename to doc/modules/cassandra/pages/managing/configuration/cass_cl_archive_file.adoc diff --git a/doc/modules/cassandra/pages/configuration/cass_env_sh_file.adoc b/doc/modules/cassandra/pages/managing/configuration/cass_env_sh_file.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/cass_env_sh_file.adoc rename to doc/modules/cassandra/pages/managing/configuration/cass_env_sh_file.adoc diff --git a/doc/modules/cassandra/pages/configuration/cass_jvm_options_file.adoc b/doc/modules/cassandra/pages/managing/configuration/cass_jvm_options_file.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/cass_jvm_options_file.adoc rename to doc/modules/cassandra/pages/managing/configuration/cass_jvm_options_file.adoc diff --git a/doc/modules/cassandra/pages/configuration/cass_logback_xml_file.adoc b/doc/modules/cassandra/pages/managing/configuration/cass_logback_xml_file.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/cass_logback_xml_file.adoc rename to doc/modules/cassandra/pages/managing/configuration/cass_logback_xml_file.adoc diff --git a/doc/modules/cassandra/pages/configuration/cass_rackdc_file.adoc b/doc/modules/cassandra/pages/managing/configuration/cass_rackdc_file.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/cass_rackdc_file.adoc rename to doc/modules/cassandra/pages/managing/configuration/cass_rackdc_file.adoc diff --git a/doc/modules/cassandra/pages/configuration/cass_topo_file.adoc b/doc/modules/cassandra/pages/managing/configuration/cass_topo_file.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/cass_topo_file.adoc rename to doc/modules/cassandra/pages/managing/configuration/cass_topo_file.adoc diff --git a/doc/modules/cassandra/pages/configuration/configuration.adoc b/doc/modules/cassandra/pages/managing/configuration/configuration.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/configuration.adoc rename to doc/modules/cassandra/pages/managing/configuration/configuration.adoc diff --git a/doc/modules/cassandra/pages/configuration/index.adoc b/doc/modules/cassandra/pages/managing/configuration/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/configuration/index.adoc rename to doc/modules/cassandra/pages/managing/configuration/index.adoc diff --git a/doc/modules/cassandra/pages/operating/audit_logging.adoc b/doc/modules/cassandra/pages/managing/operating/audit_logging.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/audit_logging.adoc rename to doc/modules/cassandra/pages/managing/operating/audit_logging.adoc diff --git a/doc/modules/cassandra/pages/operating/auditlogging.adoc b/doc/modules/cassandra/pages/managing/operating/auditlogging.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/auditlogging.adoc rename to doc/modules/cassandra/pages/managing/operating/auditlogging.adoc diff --git a/doc/modules/cassandra/pages/operating/backups.adoc b/doc/modules/cassandra/pages/managing/operating/backups.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/backups.adoc rename to doc/modules/cassandra/pages/managing/operating/backups.adoc diff --git a/doc/modules/cassandra/pages/operating/bloom_filters.adoc b/doc/modules/cassandra/pages/managing/operating/bloom_filters.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/bloom_filters.adoc rename to doc/modules/cassandra/pages/managing/operating/bloom_filters.adoc diff --git a/doc/modules/cassandra/pages/operating/bulk_loading.adoc b/doc/modules/cassandra/pages/managing/operating/bulk_loading.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/bulk_loading.adoc rename to doc/modules/cassandra/pages/managing/operating/bulk_loading.adoc diff --git a/doc/modules/cassandra/pages/operating/cdc.adoc b/doc/modules/cassandra/pages/managing/operating/cdc.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/cdc.adoc rename to doc/modules/cassandra/pages/managing/operating/cdc.adoc diff --git a/doc/modules/cassandra/pages/operating/compaction/index.adoc b/doc/modules/cassandra/pages/managing/operating/compaction/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/compaction/index.adoc rename to doc/modules/cassandra/pages/managing/operating/compaction/index.adoc diff --git a/doc/modules/cassandra/pages/operating/compaction/lcs.adoc b/doc/modules/cassandra/pages/managing/operating/compaction/lcs.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/compaction/lcs.adoc rename to doc/modules/cassandra/pages/managing/operating/compaction/lcs.adoc diff --git a/doc/modules/cassandra/pages/operating/compaction/stcs.adoc b/doc/modules/cassandra/pages/managing/operating/compaction/stcs.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/compaction/stcs.adoc rename to doc/modules/cassandra/pages/managing/operating/compaction/stcs.adoc diff --git a/doc/modules/cassandra/pages/operating/compaction/twcs.adoc b/doc/modules/cassandra/pages/managing/operating/compaction/twcs.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/compaction/twcs.adoc rename to doc/modules/cassandra/pages/managing/operating/compaction/twcs.adoc diff --git a/doc/modules/cassandra/pages/operating/compression.adoc b/doc/modules/cassandra/pages/managing/operating/compression.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/compression.adoc rename to doc/modules/cassandra/pages/managing/operating/compression.adoc diff --git a/doc/modules/cassandra/pages/operating/denylisting_partitions.adoc b/doc/modules/cassandra/pages/managing/operating/denylisting_partitions.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/denylisting_partitions.adoc rename to doc/modules/cassandra/pages/managing/operating/denylisting_partitions.adoc diff --git a/doc/modules/cassandra/pages/operating/fqllogging.adoc b/doc/modules/cassandra/pages/managing/operating/fqllogging.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/fqllogging.adoc rename to doc/modules/cassandra/pages/managing/operating/fqllogging.adoc diff --git a/doc/modules/cassandra/pages/operating/hardware.adoc b/doc/modules/cassandra/pages/managing/operating/hardware.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/hardware.adoc rename to doc/modules/cassandra/pages/managing/operating/hardware.adoc diff --git a/doc/modules/cassandra/pages/operating/hints.adoc b/doc/modules/cassandra/pages/managing/operating/hints.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/hints.adoc rename to doc/modules/cassandra/pages/managing/operating/hints.adoc diff --git a/doc/modules/cassandra/pages/operating/index.adoc b/doc/modules/cassandra/pages/managing/operating/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/index.adoc rename to doc/modules/cassandra/pages/managing/operating/index.adoc diff --git a/doc/modules/cassandra/pages/operating/metrics.adoc b/doc/modules/cassandra/pages/managing/operating/metrics.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/metrics.adoc rename to doc/modules/cassandra/pages/managing/operating/metrics.adoc diff --git a/doc/modules/cassandra/pages/operating/read_repair.adoc b/doc/modules/cassandra/pages/managing/operating/read_repair.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/read_repair.adoc rename to doc/modules/cassandra/pages/managing/operating/read_repair.adoc diff --git a/doc/modules/cassandra/pages/operating/repair.adoc b/doc/modules/cassandra/pages/managing/operating/repair.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/repair.adoc rename to doc/modules/cassandra/pages/managing/operating/repair.adoc diff --git a/doc/modules/cassandra/pages/operating/security.adoc b/doc/modules/cassandra/pages/managing/operating/security.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/security.adoc rename to doc/modules/cassandra/pages/managing/operating/security.adoc diff --git a/doc/modules/cassandra/pages/operating/topo_changes.adoc b/doc/modules/cassandra/pages/managing/operating/topo_changes.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/topo_changes.adoc rename to doc/modules/cassandra/pages/managing/operating/topo_changes.adoc diff --git a/doc/modules/cassandra/pages/operating/transientreplication.adoc b/doc/modules/cassandra/pages/managing/operating/transientreplication.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/transientreplication.adoc rename to doc/modules/cassandra/pages/managing/operating/transientreplication.adoc diff --git a/doc/modules/cassandra/pages/operating/virtualtables.adoc b/doc/modules/cassandra/pages/managing/operating/virtualtables.adoc similarity index 100% rename from doc/modules/cassandra/pages/operating/virtualtables.adoc rename to doc/modules/cassandra/pages/managing/operating/virtualtables.adoc diff --git a/doc/modules/cassandra/pages/tools/cassandra_stress.adoc b/doc/modules/cassandra/pages/managing/tools/cassandra_stress.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/cassandra_stress.adoc rename to doc/modules/cassandra/pages/managing/tools/cassandra_stress.adoc diff --git a/doc/modules/cassandra/pages/tools/cqlsh.adoc b/doc/modules/cassandra/pages/managing/tools/cqlsh.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/cqlsh.adoc rename to doc/modules/cassandra/pages/managing/tools/cqlsh.adoc diff --git a/doc/modules/cassandra/pages/tools/hash_password.adoc b/doc/modules/cassandra/pages/managing/tools/hash_password.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/hash_password.adoc rename to doc/modules/cassandra/pages/managing/tools/hash_password.adoc diff --git a/doc/modules/cassandra/pages/tools/index.adoc b/doc/modules/cassandra/pages/managing/tools/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/index.adoc rename to doc/modules/cassandra/pages/managing/tools/index.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/index.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/index.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/index.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstabledump.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstabledump.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstabledump.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstabledump.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstableexpiredblockers.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstableexpiredblockers.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstableexpiredblockers.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstableexpiredblockers.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstablelevelreset.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstablelevelreset.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstablelevelreset.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstablelevelreset.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstableloader.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstableloader.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstableloader.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstableloader.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstablemetadata.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstablemetadata.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstablemetadata.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstablemetadata.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstableofflinerelevel.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstableofflinerelevel.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstableofflinerelevel.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstableofflinerelevel.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstablerepairedset.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstablerepairedset.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstablerepairedset.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstablerepairedset.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstablescrub.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstablescrub.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstablescrub.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstablescrub.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstablesplit.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstablesplit.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstablesplit.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstablesplit.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstableupgrade.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstableupgrade.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstableupgrade.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstableupgrade.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstableutil.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstableutil.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstableutil.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstableutil.adoc diff --git a/doc/modules/cassandra/pages/tools/sstable/sstableverify.adoc b/doc/modules/cassandra/pages/managing/tools/sstable/sstableverify.adoc similarity index 100% rename from doc/modules/cassandra/pages/tools/sstable/sstableverify.adoc rename to doc/modules/cassandra/pages/managing/tools/sstable/sstableverify.adoc diff --git a/doc/modules/cassandra/pages/new/virtualtables.adoc b/doc/modules/cassandra/pages/managing/virtualtables.adoc similarity index 100% rename from doc/modules/cassandra/pages/new/virtualtables.adoc rename to doc/modules/cassandra/pages/managing/virtualtables.adoc diff --git a/doc/modules/cassandra/pages/new/4.1-new.adoc b/doc/modules/cassandra/pages/new/4.1-new.adoc new file mode 100644 index 0000000000..a6545a74bc --- /dev/null +++ b/doc/modules/cassandra/pages/new/4.1-new.adoc @@ -0,0 +1,20 @@ += New Features in Apache Cassandra 4.1 + +This section covers the new features in Apache Cassandra 4.1. + + +* https://issues.apache.org/jira/browse/CASSANDRA-17164[Paxos v2] +* link:/_/blog/Apache-Cassandra-4.1-Features-Guardrails-Framework.html[Guardrails] +* link:/_/blog/Apache-Cassandra-4.1-Configuration-Standardization.html[New and Improved Configuration Format] +* link:/_/blog/Apache-Cassandra-4.1-Features-Client-side-Password-Hashing.html[Client-side Password Hashing] +* link:/_/blog/Apache-Cassandra-4.1-Denylisting-Partitions.html[Partition Denylist] +* Lots of CQL improvements +* link:/_/blog/Apache-Cassandra-4.1-New-SSTable-Identifiers.html[New SSTable Identifiers] +* https://issues.apache.org/jira/browse/CASSANDRA-17423[Native Transport rate limiting] +* https://issues.apache.org/jira/browse/CASSANDRA-16310[Top partition tracking per table] +* https://issues.apache.org/jira/browse/CASSANDRA-14309[Hint Window consistency] +* https://issues.apache.org/jira/browse/CASSANDRA-17044[Pluggability] +** link:/_/blog/Apache-Cassandra-4.1-Features-Pluggable-Memtable-Implementations.html[Memtable] +** Encryption +** link:/_/blog/Apache-Cassandra-4.1-Features-Authentication-Plugin-Support-for-CQLSH.html[CQLSH Authentication] +* and much link:https://github.com/apache/cassandra/blob/cassandra-4.1/NEWS.txt[more] diff --git a/doc/modules/cassandra/pages/new/4.2-new.adoc b/doc/modules/cassandra/pages/new/4.2-new.adoc new file mode 100644 index 0000000000..d801de399f --- /dev/null +++ b/doc/modules/cassandra/pages/new/4.2-new.adoc @@ -0,0 +1,12 @@ += New Features in Apache Cassandra 4.2 + +This section covers the new features in Apache Cassandra 4.2. + + +* Added new Mathematical CQL functions: abs, exp, log, log10 and round. +* Adds a trie-based memtable implementation +* CQL things - maxwritetime, writetime and ttl on elements of collections and udts +* Added new CQL native scalar functions for collections. The new functions are mostly analogous to the existing + aggregation functions, but they operate on the elements of collection columns. The new functions are `map_keys`, + `map_values`, `collection_count`, `collection_min`, `collection_max`, `collection_sum` and `collection_avg`. +* number of options diff --git a/doc/modules/cassandra/pages/faq/index.adoc b/doc/modules/cassandra/pages/overview/faq/index.adoc similarity index 100% rename from doc/modules/cassandra/pages/faq/index.adoc rename to doc/modules/cassandra/pages/overview/faq/index.adoc diff --git a/doc/modules/cassandra/pages/overview/terminology.adoc b/doc/modules/cassandra/pages/overview/terminology.adoc new file mode 100644 index 0000000000..8200056e18 --- /dev/null +++ b/doc/modules/cassandra/pages/overview/terminology.adoc @@ -0,0 +1,23 @@ += Terminology + +a | b | xref:#c[c] | d | e | f + +[[c]] +cluster:: +A ring of nodes that holds a database. + +node:: +A machine that holds Cassandra replicas. +Each node holds a portion of the whole database. + +replica:: +A copy of a portion of the whole database. Each node holds some replicas. + +replication:: +The process of creating replicas across nodes in a cluster. + +replication factor (RF):: +A scalar value that sets the number of replicas of each partition in a cluster. +For example, and RF=3 means that three nodes hold a replica of each partition. + + diff --git a/doc/modules/cassandra/pages/getting_started/java11.adoc b/doc/modules/cassandra/pages/references/java11.adoc similarity index 100% rename from doc/modules/cassandra/pages/getting_started/java11.adoc rename to doc/modules/cassandra/pages/references/java11.adoc diff --git a/doc/modules/cassandra/pages/tooling/cass-stress-deprecated b/doc/modules/cassandra/pages/tooling/cass-stress-deprecated new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/modules/cassandra/pages/tooling/generate-tokens b/doc/modules/cassandra/pages/tooling/generate-tokens new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/modules/cassandra/pages/tooling/hash-password-tool b/doc/modules/cassandra/pages/tooling/hash-password-tool new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/modules/cassandra/partials/nodetool_and_cqlsh.adoc b/doc/modules/cassandra/partials/nodetool_and_cqlsh.adoc index d1c4e73a2f..80da915e45 100644 --- a/doc/modules/cassandra/partials/nodetool_and_cqlsh.adoc +++ b/doc/modules/cassandra/partials/nodetool_and_cqlsh.adoc @@ -1,5 +1,5 @@ NOTE: For information on how to configure your installation, see -{cass_url}doc/latest/getting_started/configuring.html[Configuring +{cass_url}doc/latest/getting-started/configuring.html[Configuring Cassandra]. [arabic, start=7] diff --git a/doc/modules/cassandra/partials/nodetool_and_cqlsh_nobin.adoc b/doc/modules/cassandra/partials/nodetool_and_cqlsh_nobin.adoc index c17949c4bc..bf74ad2cdf 100644 --- a/doc/modules/cassandra/partials/nodetool_and_cqlsh_nobin.adoc +++ b/doc/modules/cassandra/partials/nodetool_and_cqlsh_nobin.adoc @@ -1,5 +1,5 @@ NOTE: For information on how to configure your installation, see -{cass_url}doc/latest/getting_started/configuring.html[Configuring +{cass_url}doc/latest/getting-started/configuring.html[Configuring Cassandra]. [arabic, start=7] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
