CASSANDRA-18185 Accumulate all docs PR

CHANGES.txt

@@ -808,7 +808,7 @@ Merged from 2.1:
  * Include DROPPED_COLUMNS in schema digest computation (CASSANDRA-15843)
  * Fix Cassandra restart from rpm install (CASSANDRA-15830)
  * Improve handling of 2i initialization failures (CASSANDRA-13606)
- * Add completion_ratio column to sstable_tasks virtual table (CASANDRA-15759)
+ * Add completion_ratio column to sstable_tasks virtual table (CASSANDRA-15759)
  * Add support for adding custom Verbs (CASSANDRA-15725)
  * Speed up entire-file-streaming file containment check and allow entire-file-streaming for all compaction strategies (CASSANDRA-15657,CASSANDRA-15783)
  * Provide ability to configure IAuditLogger (CASSANDRA-15748)
@@ -1081,7 +1081,7 @@ Merged from 3.0:
  * Use consistent nowInSeconds and timestamps values within a request (CASSANDRA-14671)
  * Add sampler for query time and expose with nodetool (CASSANDRA-14436)
  * Clean up Message.Request implementations (CASSANDRA-14677)
- * Disable old native protocol versions on demand (CASANDRA-14659)
+ * Disable old native protocol versions on demand (CASSANDRA-14659)
  * Allow specifying now-in-seconds in native protocol (CASSANDRA-14664)
  * Improve BTree build performance by avoiding data copy (CASSANDRA-9989)
  * Make monotonic read / read repair configurable (CASSANDRA-14635)
@@ -1098,7 +1098,7 @@ Merged from 3.0:
  * Clear view system metadata when dropping keyspace (CASSANDRA-14646)
  * Allocate ReentrantLock on-demand in java11 AtomicBTreePartitionerBase (CASSANDRA-14637)
  * Make all existing virtual tables use LocalPartitioner (CASSANDRA-14640)
- * Revert 4.0 GC alg back to CMS (CASANDRA-14636)
+ * Revert 4.0 GC alg back to CMS (CASSANDRA-14636)
  * Remove hardcoded java11 jvm args in idea workspace files (CASSANDRA-14627)
  * Update netty to 4.1.128 (CASSANDRA-14633)
  * Add a virtual table to expose thread pools (CASSANDRA-14523)
@@ -2521,7 +2521,7 @@ Merged from 2.2:
  * drop/alter user should be case sensitive (CASSANDRA-10817)
 Merged from 2.1:
  * test_bulk_round_trip_blogposts is failing occasionally (CASSANDRA-10938)
- * Fix isJoined return true only after becoming cluster member (CASANDRA-11007)
+ * Fix isJoined return true only after becoming cluster member (CASSANDRA-11007)
  * Fix bad gossip generation seen in long-running clusters (CASSANDRA-10969)
  * Avoid NPE when incremental repair fails (CASSANDRA-10909)
  * Unmark sstables compacting once they are done in cleanup/scrub/upgradesstables (CASSANDRA-10829)
@@ -2987,7 +2987,7 @@ Merged from 2.0:
  * Deprected sstable2json and json2sstable (CASSANDRA-9618)
  * Allow native functions in user-defined aggregates (CASSANDRA-9542)
  * Don't repair system_distributed by default (CASSANDRA-9621)
- * Fix mixing min, max, and count aggregates for blob type (CASSANRA-9622)
+ * Fix mixing min, max, and count aggregates for blob type (CASSANDRA-9622)
  * Rename class for DATE type in Java driver (CASSANDRA-9563)
  * Duplicate compilation of UDFs on coordinator (CASSANDRA-9475)
  * Fix connection leak in CqlRecordWriter (CASSANDRA-9576)
@@ -3759,7 +3759,7 @@ Merged from 1.2:
 Merged from 2.0:
  * Configure system.paxos with LeveledCompactionStrategy (CASSANDRA-7753)
  * Fix ALTER clustering column type from DateType to TimestampType when
-   using DESC clustering order (CASSANRDA-7797)
+   using DESC clustering order (CASSANDRA-7797)
  * Throw EOFException if we run out of chunks in compressed datafile
    (CASSANDRA-7664)
  * Fix PRSI handling of CQL3 row markers for row cleanup (CASSANDRA-7787)
@@ -3796,7 +3796,7 @@ Merged from 2.0:
  * Fix OOM issue from netty caching over time (CASSANDRA-7743)
  * json2sstable couldn't import JSON for CQL table (CASSANDRA-7477)
  * Invalidate all caches on table drop (CASSANDRA-7561)
- * Skip strict endpoint selection for ranges if RF == nodes (CASSANRA-7765)
+ * Skip strict endpoint selection for ranges if RF == nodes (CASSANDRA-7765)
  * Fix Thrift range filtering without 2ary index lookups (CASSANDRA-7741)
  * Add tracing entries about concurrent range requests (CASSANDRA-7599)
  * (cqlsh) Fix DESCRIBE for NTS keyspaces (CASSANDRA-7729)
@@ -4580,7 +4580,7 @@ Merged from 1.2:
  * Fix assertion error during repair (CASSANDRA-5801)
  * Fix range tombstone bug (CASSANDRA-5805)
  * DC-local CAS (CASSANDRA-5797)
- * Add a native_protocol_version column to the system.local table (CASSANRDA-5819)
+ * Add a native_protocol_version column to the system.local table (CASSANDRA-5819)
  * Use index_interval from cassandra.yaml when upgraded (CASSANDRA-5822)
  * Fix buffer underflow on socket close (CASSANDRA-5792)
 Merged from 1.2:
@@ -4743,7 +4743,7 @@ Merged from 1.2:
  * Race condition in detecting version on a mixed 1.1/1.2 cluster
    (CASSANDRA-5692)
  * Fix skipping range tombstones with reverse queries (CASSANDRA-5712)
- * Expire entries out of ThriftSessionManager (CASSANRDA-5719)
+ * Expire entries out of ThriftSessionManager (CASSANDRA-5719)
  * Don't keep ancestor information in memory (CASSANDRA-5342)
  * cqlsh: fix handling of semicolons inside BATCH queries (CASSANDRA-5697)
 
@@ -6578,7 +6578,7 @@ Merged from 0.8:
  * add IntegerType to CLI help (CASSANDRA-2414)
  * avoid caching token-only decoratedkeys (CASSANDRA-2416)
  * convert mmap assertion to if/throw so scrub can catch it (CASSANDRA-2417)
- * don't overwrite gc log (CASSANDR-2418)
+ * don't overwrite gc log (CASSANDRA-2418)
  * invalidate row cache for streamed row to avoid inconsitencies
    (CASSANDRA-2420)
  * avoid copies in range/index scans (CASSANDRA-2425)
@@ -6964,7 +6964,7 @@ Merged from 0.8:
 
 0.7-beta2
  * always use UTF-8 for hint keys (CASSANDRA-1439)
- * remove cassandra.yaml dependency from Hadoop and Pig (CASSADRA-1322)
+ * remove cassandra.yaml dependency from Hadoop and Pig (CASSANDRA-1322)
  * expose CfDef metadata in describe_keyspaces (CASSANDRA-1363)
  * restore use of mmap_index_only option (CASSANDRA-1241)
  * dropping a keyspace with no column families generated an error
@@ -7345,7 +7345,7 @@ Merged from 0.8:
  * stress.py moved to contrib (CASSANDRA-635)
  * row caching [must be explicitly enabled per-CF in config] (CASSANDRA-678)
  * present a useful measure of compaction progress in JMX (CASSANDRA-599)
- * add bin/sstablekeys (CASSNADRA-679)
+ * add bin/sstablekeys (CASSANDRA-679)
  * add ConsistencyLevel.ANY (CASSANDRA-687)
  * make removetoken remove nodes from gossip entirely (CASSANDRA-644)
  * add ability to set cache sizes at runtime (CASSANDRA-708)

NEWS.txt

@@ -91,7 +91,7 @@ New features
       have something in hbState() you don't expect. See CASSANDRA-17842 for further details.
     - Added new CQL table property 'allow_auto_snapshot' which is by default true. When set to false and 'auto_snapshot: true'
       in cassandra.yaml, there will be no snapshot taken when a table is truncated or dropped. When auto_snapshot in
-      casandra.yaml is set to false, the newly added table property does not have any effect.
+      cassandra.yaml is set to false, the newly added table property does not have any effect.
     - Changed default on resumable bootstrap to be disabled. Resumable bootstrap has edge cases with potential correctness
       violations or data loss scenarios if nodes go down during bootstrap, tombstones are written, and operations race with
       repair. As streaming is considerably faster in the 4.0+ era (as well as with zero copy streaming), the risks of
@@ -105,7 +105,7 @@ New features
       Please uncomment the respective appender in logback.xml file to make logs flow into this table. This feature is turned off by default.
     - Added new CQL table property 'incremental_backups' which is by default true. When 'incremental_backups' property in cassandra.yaml
       is set to true and table property is set to false, incremental backups for that specific table will not be done.
-      When 'incremental_backups' in casandra.yaml is set to false, the newly added table property does not have any effect.
+      When 'incremental_backups' in cassandra.yaml is set to false, the newly added table property does not have any effect.
       Both properties have to be set to true (cassandra.yaml and table property) in order to make incremental backups.
     - 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`,
@@ -1826,7 +1826,7 @@ Upgrading
     - index_interval is now moved to ColumnFamily property. You can change value
       with ALTER TABLE ... WITH statement and SSTables written after that will
       have new value. When upgrading, Cassandra will pick up the value defined in
-      cassanda.yaml as the default for existing ColumnFamilies, until you explicitly
+      cassandra.yaml as the default for existing ColumnFamilies, until you explicitly
       set the value for those.
     - The deprecated native_transport_min_threads option has been removed in
       Cassandra.yaml.

TESTING.md

@@ -364,14 +364,14 @@ dependencies into the constructor is not practical, wrapping accesses to global
 
 
 **Example, alternative**
-```javayy
+```java
 class SomeVerbHandler implements IVerbHandler<SomeMessage>
 { 
 	@VisibleForTesting
 	protected boolean isAlive(InetAddress addr) { return FailureDetector.instance.isAlive(msg.payload.otherNode); }
 
 	@VisibleForTesting
-	protected void streamSomethind(InetAddress to) { new StreamPlan(to).requestRanges(someRanges).execute(); }
+	protected void streamSomething(InetAddress to) { new StreamPlan(to).requestRanges(someRanges).execute(); }
 
 	@VisibleForTesting
 	protected void compactSomething(ColumnFamilyStore cfs ) { CompactionManager.instance.submitBackground(); }
@@ -404,7 +404,7 @@ class SomeVerbTest
 		protected boolean isAlive(InetAddress addr) { return alive; }
 
 		@Override
-		protected void streamSomethind(InetAddress to) { streamCalled = true; }
+		protected void streamSomething(InetAddress to) { streamCalled = true; }
 
 		@Override
 		protected void compactSomething(ColumnFamilyStore cfs ) { compactCalled = true; }

build.xml

@@ -1501,7 +1501,7 @@
       <executiondata>
         <file file="${jacoco.finalexecfile}" />
       </executiondata>
-      <structure name="JaCoCo Cassandara Coverage Report">
+      <structure name="JaCoCo Cassandra Coverage Report">
         <classfiles>
           <fileset dir="${build.classes.main}">
             <include name="**/*.class"/>

conf/cassandra.yaml

@@ -44,8 +44,8 @@ num_tokens: 16
 allocate_tokens_for_local_replication_factor: 3
 
 # initial_token allows you to specify tokens manually.  While you can use it with
-# vnodes (num_tokens > 1, above) -- in which case you should provide a 
-# comma-separated list -- it's primarily used when adding nodes to legacy clusters 
+# vnodes (num_tokens > 1, above) -- in which case you should provide a
+# comma-separated list -- it's primarily used when adding nodes to legacy clusters
 # that do not have vnodes enabled.
 # initial_token:
 
@@ -290,7 +290,7 @@ credentials_validity: 2000ms
 partitioner: org.apache.cassandra.dht.Murmur3Partitioner
 
 # Directories where Cassandra should store data on disk. If multiple
-# directories are specified, Cassandra will spread data evenly across 
+# directories are specified, Cassandra will spread data evenly across
 # them by partitioning the token ranges.
 # If not set, the default directory is $CASSANDRA_HOME/data/data.
 # data_file_directories:
@@ -496,8 +496,8 @@ counter_cache_save_period: 7200s
 # Min unit: s
 # cache_load_timeout: 30s
 
-# commitlog_sync may be either "periodic", "group", or "batch." 
-# 
+# commitlog_sync may be either "periodic", "group", or "batch."
+#
 # When in batch mode, Cassandra won't ack writes until the commit log
 # has been flushed to disk.  Each incoming write will trigger the flush task.
 # commitlog_sync_batch_window_in_ms is a deprecated value. Previously it had
@@ -940,7 +940,7 @@ incremental_backups: false
 snapshot_before_compaction: false
 
 # Whether or not a snapshot is taken of the data before keyspace truncation
-# or dropping of column families. The STRONGLY advised default of true 
+# or dropping of column families. The STRONGLY advised default of true
 # should be used to provide data safety. If you set this flag to false, you will
 # lose data on truncation or drop.
 auto_snapshot: true
@@ -994,7 +994,7 @@ column_index_cache_size: 2KiB
 #
 # concurrent_compactors defaults to the smaller of (number of disks,
 # number of cores), with a minimum of 2 and a maximum of 8.
-# 
+#
 # If your data directories are backed by SSD, you should increase this
 # to the number of cores.
 # concurrent_compactors: 1
@@ -1022,7 +1022,7 @@ compaction_throughput: 64MiB/s
 
 # When compacting, the replacement sstable(s) can be opened before they
 # are completely written, and used in place of the prior sstables for
-# any range that has been written. This helps to smoothly transfer reads 
+# any range that has been written. This helps to smoothly transfer reads
 # between the sstables, reducing page cache churn and keeping hot rows hot
 # Set sstable_preemptive_open_interval to null for disabled which is equivalent to
 # sstable_preemptive_open_interval_in_mb being negative
@@ -1170,10 +1170,10 @@ slow_query_log_timeout: 500ms
 # Enable operation timeout information exchange between nodes to accurately
 # measure request timeouts.  If disabled, replicas will assume that requests
 # were forwarded to them instantly by the coordinator, which means that
-# under overload conditions we will waste that much extra time processing 
+# under overload conditions we will waste that much extra time processing
 # already-timed-out requests.
 #
-# Warning: It is generally assumed that users have setup NTP on their clusters, and that clocks are modestly in sync, 
+# Warning: It is generally assumed that users have setup NTP on their clusters, and that clocks are modestly in sync,
 # since this is a requirement for general correctness of last write wins.
 # internode_timeout: true
 
@@ -1586,7 +1586,7 @@ compaction_tombstone_warning_threshold: 100000
 # max_concurrent_automatic_sstable_upgrades: 1
 
 # Audit logging - Logs every incoming CQL command request, authentication to a node. See the docs
-# on audit_logging for full details about the various configuration options.
+# on audit_logging for full details about the various configuration options and production tips.
 audit_logging_options:
   enabled: false
   logger:
@@ -1602,11 +1602,13 @@ audit_logging_options:
   # block: true
   # max_queue_weight: 268435456 # 256 MiB
   # max_log_size: 17179869184 # 16 GiB
-  ## archive command is "/path/to/script.sh %path" where %path is replaced with the file being rolled:
+  #
+  ## If archive_command is empty or unset, Cassandra uses a built-in DeletingArchiver that deletes the oldest files if ``max_log_size`` is reached.
+  ## If archive_command is set, Cassandra do **not** use the DeletingArchiver, so it's the responsability of the script to make any required cleanup.
+  ## Example: "/path/to/script.sh %path" where %path is replaced with the file being rolled.
   # archive_command:
   # max_archive_retries: 10
 
-
 # default options for full query logging - these can be overridden from command line when executing
 # nodetool enablefullquerylog
 # full_query_logging_options:

conf/cqlshrc.sample

@@ -15,15 +15,14 @@
 ; specific language governing permissions and limitations
 ; under the License.
 ;
-; Sample ~/.cqlshrc file.
+; Sample ~/.cassandra/cqlshrc file.
 
 [authentication]
 ;; If Cassandra has auth enabled, fill out these options
 ;; Path to the credentials file, an initial ~ or ~user is expanded to that user's home directory
 ; credentials = ~/.cassandra/credentials
 ; keyspace = ks1
 
-
 [auth_provider]
 ;; you can specify any auth provider found in your python environment
 ;; module and class will be used to dynamically load the class
@@ -33,6 +32,10 @@
 ; classname = PlainTextAuthProvider
 ; username = user1
 
+[protocol]
+;; Specify a specific protcol version otherwise the client will default and downgrade as necessary
+; version = None
+
 [ui]
 ;; Whether or not to display query results with colors
 ; color = on
@@ -153,9 +156,8 @@ port = 9042
 ; boolstyle = True,False
 
 ;; The number of child worker processes to create for
-;; COPY tasks.  Defaults to a max of 4 for COPY FROM and 16
-;; for COPY TO.  However, at most (num_cores - 1) processes
-;; will be created.
+;; COPY tasks.  Defaults to 16 for `COPY` tasks.
+;; However, at most (num_cores - 1) processes will be created.
 ; numprocesses =
 
 ;; The maximum number of failed attempts to fetch a range of data (when using

doc/modules/cassandra/examples/BNF/alter_table.bnf

@@ -1,5 +1,5 @@
 alter_table_statement::= ALTER TABLE [ IF EXISTS ] table_name alter_table_instruction
 alter_table_instruction::= ADD [ IF NOT EXISTS ] column_name cql_type ( ',' column_name cql_type )*
-	| DROP [ IF EXISTS ] column_name ( column_name )*
+	| DROP [ IF EXISTS ] column_name ( ',' column_name )*
 	| RENAME [ IF EXISTS ] column_name to column_name (AND column_name to column_name)*
 	| WITH options