Beruflich Dokumente
Kultur Dokumente
Contents
Apache Cassandra 1.0 Documentation
Introduction to Apache Cassandra
Getting Started with Cassandra Java Prerequisites Download the Software Install the Software Start the Cassandra Server Login to Cassandra Create a Keyspace (database) Create a Column Family Insert, Update, Delete, Read Data
1
1
1 1 1 1 1 1 1 2 2
2
2 2 3 4 5 5 5 6 6 6 7 8 8 8 8
8
8 9 9 10 10 12 12 13
About Replication in Cassandra About Replica Placement Strategy SimpleStrategy NetworkTopologyStrategy About Snitches SimpleSnitch DseSimpleSnitch RackInferringSnitch PropertyFileSnitch EC2Snitch EC2MultiRegionSnitch About Dynamic Snitching About Client Requests in Cassandra About Write Requests About Multi-Data Center Write Requests About Read Requests Planning a Cassandra Cluster Deployment Selecting Hardware for Enterprise Implementations Memory CPU Disk Number of Nodes Network Planning an Amazon EC2 Cluster Calculating Usable Disk Capacity Calculating User Data Size Choosing Node Configuration Options Storage Settings Gossip Settings Purging Gossip State on a Node Partitioner Settings Snitch Settings Configuring the PropertyFileSnitch Choosing Keyspace Replication Options
13 14 14 14 17 18 18 18 19 19 19 19 19 20 20 21 22 22 22 23 23 23 24 24 24 25 25 25 25 26 26 26 26 27
28
28 28 28 29
Installing Cassandra Debian Packages Installing the JRE on Ubuntu Systems About Packaged Installs Next Steps Installing the Cassandra Tarball Distribution About Cassandra Binary Installations Installing JNA Next Steps Initializing a Cassandra Cluster on Amazon EC2 Using the DataStax AMI Creating an EC2 Security Group for DataStax Community Edition Launching the DataStax Community AMI Connecting to Your Cassandra EC2 Instance Configuring and Starting a Cassandra Cluster Initializing a Multi-Node or Multi-Data Center Cluster Calculating Tokens Calculating Tokens for Multiple Racks Calculating Tokens for a Single Data Center Calculating Tokens for a Multi-Data Center Cluster Starting and Stopping a Cassandra Node Starting/Stopping Cassandra as a Stand-Alone Process Starting/Stopping Cassandra as a Service Upgrading Cassandra Best Practices for Upgrading Cassandra Upgrading Cassandra: 0.8.x to 1.0.x New and Changed Parameters between 0.8 and 1.0 Upgrading Between Minor Releases of Cassandra 1.0.x
30 31 31 32 32 33 33 33 33 34 35 36 39 39 41 41 41 42 43 44 44 44 44 45 46 46
47
47 47 49 49 50 51 51 51 52 52 53 53
About Comparators About Column Family Compression When to Use Compression Configuring Compression on a Column Family About Indexes in Cassandra About Primary Indexes About Secondary Indexes Building and Using Secondary Indexes Planning Your Data Model Start with Queries Denormalize to Optimize Planning for Concurrent Writes Using Natural or Surrogate Row Keys UUID Types for Column Names
54 54 54 54 55 55 55 55 56 56 56 56 57 57
57
57 57 58 58 58 59 59 60 60 60 61 61 62 62 62 62 63 63 63 63 63 63 64 64
Creating a Column Family Creating a Counter Column Family Inserting Rows and Columns Reading Rows and Columns Setting an Expiring Column Indexing a Column Deleting Rows and Columns Dropping Column Families and Keyspaces Getting Started with CQL Starting the CQL Command-Line Program (cqlsh) Running CQL Commands with cqlsh Creating a Keyspace Creating a Column Family Inserting and Retrieving Columns Adding Columns with ALTER COLUMNFAMILY Altering Column Metadata Specifying Column Expiration with TTL Dropping Column Metadata Indexing a Column Deleting Columns and Rows Dropping Column Families and Keyspaces
64 65 65 66 66 67 67 67 67 67 68 68 68 68 69 69 69 69 69 70 70
Configuration
Node and Cluster Configuration (cassandra.yaml) Node and Cluster Initialization Properties auto_bootstrap broadcast_address cluster_name commitlog_directory data_file_directories initial_token listen_address partitioner rpc_address rpc_port saved_caches_directory seed_provider seeds storage_port endpoint_snitch
70
70 72 72 72 72 72 72 73 73 73 73 73 73 73 73 73 74
Performance Tuning Properties column_index_size_in_kb commitlog_sync commitlog_sync_period_in_ms commitlog_total_space_in_mb compaction_preheat_key_cache compaction_throughput_mb_per_sec concurrent_compactors concurrent_reads concurrent_writes flush_largest_memtables_at in_memory_compaction_limit_in_mb index_interval memtable_flush_queue_size memtable_flush_writers memtable_total_space_in_mb multithreaded_compaction reduce_cache_capacity_to reduce_cache_sizes_at sliced_buffer_size_in_kb stream_throughput_outbound_megabits_per_sec Remote Procedure Call Tuning Properties request_scheduler request_scheduler_id request_scheduler_options throttle_limit default_weight weights rpc_keepalive rpc_max_threads rpc_min_threads rpc_recv_buff_size_in_bytes rpc_send_buff_size_in_bytes rpc_timeout_in_ms rpc_server_type thrift_framed_transport_size_in_mb thrift_max_message_length_in_mb Internode Communication and Fault Detection Properties dynamic_snitch
74 74 74 74 74 74 74 74 75 75 75 75 75 75 75 75 76 76 76 76 76 76 76 76 76 76 77 77 77 77 77 77 77 77 77 77 78 78 78
dynamic_snitch_badness_threshold dynamic_snitch_reset_interval_in_ms dynamic_snitch_update_interval_in_ms hinted_handoff_enabled hinted_handoff_throttle_delay_in_ms max_hint_window_in_ms phi_convict_threshold Automatic Backup Properties incremental_backups snapshot_before_compaction Security Properties authenticator authority internode_encryption keystore keystore_password truststore truststore_password Keyspace and Column Family Storage Configuration Keyspace Attributes name placement_strategy strategy_options Column Family Attributes column_metadata column_type comment compaction_strategy compaction_strategy_options comparator compare_subcolumns_with compression_options default_validation_class gc_grace_seconds key_cache_save_period_in_seconds keys_cached key_validation_class name read_repair_chance
78 78 78 78 78 78 78 78 78 79 79 79 79 79 79 79 79 79 80 80 80 80 80 81 81 82 82 82 82 83 83 83 83 83 84 84 84 84 84
replicate_on_write max_compaction_threshold min_compaction_threshold memtable_flush_after_mins memtable_operations_in_millions memtable_throughput_in_mb rows_cached row_cache_provider row_cache_save_period_in_seconds Java and System Environment Settings Configuration Heap Sizing Options JMX Options Further Reading on JVM Tuning Authentication and Authorization Configuration access.properties passwd.properties Logging Configuration Logging Levels via the Properties File Logging Levels via JMX
84 84 84 84 85 85 85 85 85 85 85 85 86 86 86 87 87 87 87
Operations
Monitoring a Cassandra Cluster Monitoring Using DataStax OpsCenter Monitoring Using nodetool Monitoring Using JConsole Compaction Metrics Thread Pool Statistics Read/Write Latency Metrics ColumnFamily Statistics Monitoring and Adjusting Cache Performance Tuning Cassandra Tuning the Cache How Caching Works Configuring the Column Family Key Cache Configuring the Column Family Row Cache Data Modeling Considerations for Cache Tuning Hardware and OS Considerations for Cache Tuning Estimating Cache Sizes Tuning Write Performance (Memtables) Tuning Java Heap Size
88
88 88 89 90 91 92 92 92 93 93 94 94 94 94 95 95 95 95 96
Tuning Java Garbage Collection Tuning Compaction Choosing a Column Family Compaction Strategy Setting the Compaction Strategy on a Column Family Tuning Options for Size-Tiered Compaction Managing a Cassandra Cluster Running Routine Node Repair Adding Capacity to an Existing Cluster Calculating Tokens For the New Nodes Adding Nodes to a Cluster Changing the Replication Factor Replacing a Dead Node Backing Up and Restoring Data Taking a Snapshot Clearing Snapshot Files Enabling Incremental Backups Restoring from a Snapshot
References
CQL Language Reference CQL Lexical Structure CQL Identifiers and Keywords CQL Constants CQL Comments CQL Consistency Levels CQL Data Types Working with Dates and Times CQL Storage Parameters CQL Keyspace Storage Parameters CQL Column Family Storage Parameters CQL Commands ALTER COLUMNFAMILY Synopsis Description Parameters Examples BATCH Synopsis Description Parameters
101
101 101 102 102 102 102 103 103 104 104 104 105 105 105 105 105 105 106 106 106 106
Example CREATE COLUMNFAMILY Synopsis Description Parameters Examples CREATE INDEX Synopsis Description Parameters Examples CREATE KEYSPACE Synopsis Description Parameters Examples DELETE Synopsis Description Parameters Example DROP COLUMNFAMILY Synopsis Description Parameters Example DROP INDEX Synopsis Description Parameters Example DROP KEYSPACE Synopsis Description Parameters Example INSERT Synopsis Description
107 107 107 107 107 108 108 108 108 108 108 109 109 109 109 109 110 110 110 110 111 111 111 111 111 111 111 111 111 111 112 112 112 112 112 112 112 112 112
Parameters Example SELECT Synopsis Description Parameters Examples TRUNCATE Synopsis Description Parameters Example UPDATE Synopsis Description Parameters <column_family> Example USE Synopsis Description Parameters Example CQLSH-Specific Commands ASSUME Synopsis Description Parameters Examples DESCRIBE Synopsis Description Parameters Examples SHOW Synopsis Description Parameters Examples
113 113 113 113 114 114 115 115 115 115 115 115 115 115 116 116 116 117 117 117 117 117 117 117 117 118 118 118 118 118 118 119 119 119 119 119 119 119 120
nodetool cassandra Usage Environment Options Examples stress Setting up the Stress Utility Usage Using the Daemon Mode (stressd) Examples sstable2json / json2sstable sstable2json Usage Output Format json2sstable Usage sstablekeys Usage
120 122 122 122 123 124 125 125 125 126 126 126 127 127 127 128 128 128 128
Troubleshooting Guide
Reads are getting slower while writes are still fast Nodes seem to freeze after some period of time Nodes are dying with OOM errors Nodetool or JMX connections failing on remote nodes View of ring differs between some nodes Java reports an error saying there are too many open files Cannot initialize class org.xerial.snappy.Snappy
128
129 129 129 129 129 130 130
Java Prerequisites
Before installing Cassandra on Linux, Windows, or Mac, ensure that you have the most up-to-date version of Java installed on your machine. To determine if Java is installed on your system, in a terminal window enter: java -version
Login to Cassandra
Cassandra has a couple of interfaces that you can use to enter commands - the CLI and the CQL (Cassandra Query Language) utility. For this indroduction use the CLI, which in the Windows Cassandra group folder and in the bin directory on Linux or Mac: ./cassandra-cli -h localhost
Getting Started with Cassandra and DataStax Community Edition A keyspace in Cassandra is the equivalent of a database in the RDBMS world. You can have multiple keyspaces on a Cassandra server. First create a simple keyspace to work with: [default@unknown] create keyspace mykeyspace; [default@unknown] use mykeyspace;
Getting Started with Cassandra and DataStax Community Edition Cassandra is a Java program and requires a Java Virtual Machine (JVM) to be installed before you can start the server. For production deployments, you will need the Sun Java Runtime Environment 1.6.0_19 or later, but if you are just installing an evaluation instance, any JVM is fine. To check for Java, run the following command in a terminal session: # java -version If you do not have Java installed, see Installing the JRE on RedHat Systems or Installing the JRE on Ubuntu Systems for instructions.
Note
The instructions in this section are not intended for production installations, just for a quick start tutorial. See Planning a Cassandra Cluster Deployment, Installing and Initializing a Cassandra Cluster, and Configuring and Starting a Cassandra Cluster for production cluster setup best practices. These instructions will walk you through setting up a self-contained, single-node instance of Cassandra in your home directory (does not require root permissions).
Note
By downloading community software from DataStax you agree to the terms of the DataStax Community EULA (End User License Agreement) posted on the DataStax web site. 1. In your home directory, create a directory called datastax. $ cd $HOME $ mkdir datastax $ cd datastax 2. In the datastax directory download the Cassandra package (required), plus the OpsCenter package (optional). For example, on Linux to get version 1.0.7 of DataStax Community and version 1.4 of OpsCenter: $ wget http://downloads.datastax.com/community/dsc.tar.gz $ wget http://downloads.datastax.com/community/opscenter.tar.gz $ wget http://downloads.datastax.com/community/dsc-1.0.1-demo-bin.tar.gz
3. Unpack the distributions: $ tar -xzvf dsc.tar.gz $ tar -xzvf opscenter.tar.gz $ tar -xzvf dsc-1.0.1-demo-bin.tar.gz $ rm *.tar.gz 4. For convenience, set the following environment variables in your user environment. For example, to configure your environment in your $HOME/.bashrc file: a. Open your .bashrc file in a text editor (such as vi): vi $HOME/.bashrc b. Add the following lines to bottom of the file: export export export export CASSANDRA_HOME=$HOME/datastax/<dsc_package_name> DSCDEMO_HOME=$HOME/datastax/dsc-1.0.1/demos/portfolio_manager OPSC_HOME=$HOME/datastax/<opscenter_package_name> PATH="$PATH:$CASSANDRA_HOME/bin:$DSCDEMO_HOME/bin:$OPSC_HOME/bin"
For example: <dsc_package_name> = dsc-cassandra-1.0.7 and <opscenter_package_name> = opscenter-1.4 c. Save and close the file. d. Source the file. source $HOME/.bashrc 5. Create the data and logging directory for Cassandra. $ mkdir $HOME/datastax/cassandra-data
2. Set the Cassandra server log location in the $CASSANDRA_HOME/conf/log4j-server.properties file to the log to the cassandra-data directory you created earlier: $ sed -i -e "s,log4j.appender.R.File=/var/log/cassandra/system.log, \ log4j.appender.R.File=$HOME/datastax/cassandra-data/system.log," \ $CASSANDRA_HOME/conf/log4j-server.properties 3. Configure the DataStax demo application to point to the correct Cassandra installation location: $ sed -i -e "s,/usr/share/cassandra,$HOME/datastax/<dsc_package_name>," \ $DSCDEMO_HOME/bin/pricer 4. Start the Cassandra server in the background. $ cassandra 5. Check that your Cassandra ring is up and running: $ nodetool ring -h localhost 6. For the next step, run the Portfolio Demo example application.
Note
There is a dependency on the Visual C++ 2008 runtime (32-bit). However, Windows 7 and Windows 2008 Server R2 already have it installed. If needed, you can download it from http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=29.
Note
You must run the pricer utility from a directory where you have write permissions (such as your home directory), or else run it as root or using sudo. 2. Run the ./bin/pricer utility to generate stock data for the application. To see all of the available options for this utility: ./bin/pricer --help The following examples will generate 100 days worth of historical data. If running on a single node cluster on localhost: ./bin/pricer -o INSERT_PRICES ./bin/pricer -o UPDATE_PORTFOLIOS ./bin/pricer -o INSERT_HISTORICAL_PRICES -n 100
4. Start the web service (must be in the $DSCDEMO_HOME/website directory to start). $ cd $DSCDEMO_HOME/website $ java -jar start.jar & 5. Open a browser and go to http://localhost:8983/portfolio (if running on the local machine) or http://<webhost_ip>:8983/portfolio (if running remotely - specify the correct IP address of the remote server). This will open the Portfolio Manager demo web application home page.
Prerequisites
Dependency on the Visual C++ 2008 runtime (32-bit). However, Windows 7 and Windows 2008 Server R2 already have it installed. If needed, download it from http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=29. If you just want to learn more about Cassandra and how it works, see the following conceptual topics: Understanding the Cassandra Architecture Understanding the Cassandra Data Model Managing and Accessing Data in Cassandra
Understanding the Cassandra Architecture In Cassandra, the gossip process runs every second and exchanges state messages with up to three other nodes in the cluster. The nodes exchange information about themselves and about the other nodes that they have gossiped about, so all nodes quickly learn about all other nodes in the cluster. A gossip message has a version associated with it, so that during a gossip exchange, older information is overwritten with the most current state for a particular node.
Note
The seed node designation has no purpose other than bootstrapping the gossip process for new nodes joining the cluster. Seed nodes are not a single point of failure, nor do they have any other special purpose in cluster operations beyond the bootstrapping of nodes. To know what range of data it is responsible for, a node must also know its own token and those of the other nodes in the cluster. When initializing a new cluster, you should generate tokens for the entire cluster and assign an initial token to each node before starting up. Each node will then gossip its token to the others. See About Data Partitioning in Cassandra for more information about partitioners and tokens.
10
Understanding the Cassandra Architecture If you do not calculate partitioner tokens so that the data ranges are evenly distributed for each data center, you could end up with uneven data distribution within a data center.
The goal is to ensure that the nodes for each data center have token assignments that evenly divide the overall range. Otherwise, you could end up with nodes in each data center that own a disproportionate number of row keys. Each data center should be partitioned as if it were its own distinct ring, however token assignments within the entire cluster cannot conflict with each other (each node must have a unique token). See Calculating Tokens for a Multi-Data Center Cluster for strategies on how to generate tokens for multi-data center clusters.
11
12
Understanding the Cassandra Architecture The primary benefit of this approach is that once your tokens are set appropriately, data from all of your column families is evenly distributed across the cluster with no further effort. For example, one column family could be using user names as the row key and another column family timestamps, but the row keys from each individual column family are still spread evenly. This also means that read and write requests to the cluster will also be evenly distributed. Another benefit of using random partitioning is the simplification of load balancing a cluster. Because each part of the hash range will receive an equal number of rows on average, it is easier to correctly assign tokens to new nodes.
13
Understanding the Cassandra Architecture As a general rule, the replication factor should not exceed the number of nodes in the cluster. However, it is possible to increase replication factor, and then add the desired number of nodes afterwards. When replication factor exceeds the number of nodes, writes will be rejected, but reads will be served as long as the desired consistency level can be met.
SimpleStrategy
SimpleStrategy is the default replica placement strategy when creating a keyspace using the Cassandra CLI. Other interfaces, such as the CQL utility, require you to explicitly specify a strategy. SimpleStrategy places the first replica on a node determined by the partitioner. Additional replicas are placed on the next nodes clockwise in the ring without considering rack or data center location.
NetworkTopologyStrategy
14
Understanding the Cassandra Architecture NetworkTopologyStrategy is the preferred replication placement strategy when you have information about how nodes are grouped in your data center, or you have (or plan to have) your cluster deployed across multiple data centers. This strategy allows you to specify how many replicas you want in each data center. When deciding how many replicas to configure in each data center, the primary considerations are (1) being able to satisfy reads locally, without incurring cross-datacenter latency, and (2) failure scenarios. The two most common ways to configure multiple data center clusters are: Two replicas in each data center. This configuration tolerates the failure of a single node per replication group, and still allows local reads at a consistency level of ONE. Three replicas in each data center. This configuration tolerates the failure of a one node per replication group at a strong consistency level of LOCAL_QUORUM, or tolerates multiple node failures per data center using consistency level ONE. Asymmetrical replication groupings are also possible depending on your use case. For example, you may want to have three replicas per data center to serve real-time application requests, and then have a single replica in a separate data center designated to running analytics. In Cassandra, the term data center is synonymous with replication group - it is a grouping of nodes configured together for replication purposes. It does not have to be a physical data center. With NetworkTopologyStrategy, replica placement is determined independently within each data center (or replication group). The first replica per data center is placed according to the partitioner (same as with SimpleStrategy). Additional replicas in the same data center are then determined by walking the ring clockwise until a node in a different rack from the previous replica is found. If there is no such node, additional replicas will be placed in the same rack. NetworkTopologyStrategy prefers to place replicas on distinct racks if possible. Nodes in the same rack (or similar physical grouping) can easily fail at the same time due to power, cooling, or network issues. Here is an example of how NetworkTopologyStrategy would place replicas spanning two data centers with a total replication factor of 4 (two replicas in Data Center 1 and two replicas in Data Center 2):
15
16
Notice how tokens are assigned to alternating racks. NetworkTopologyStrategy relies on a properly configured snitch to place replicas correctly across data centers and racks, so it is important to configure your cluster to use a snitch that can correctly determine the locations of nodes in your network.
Note
NetworkTopologyStrategy should be used in place of the OldNetworkTopologyStrategy, which only supports a limited configuration of exactly 3 replicas across 2 data centers, with no control over which data center gets two replicas for any given row key. Some rows will have two replicas in the first and one in the second, while others will have two in the second and one in the first.
About Snitches
The snitch is a configurable component of a Cassandra cluster used to define how the nodes are grouped together within the overall network topology (such as rack and data center groupings). Cassandra uses this information to route inter-node requests as efficiently as possible within the confines of the replica placement strategy. The snitch does not affect requests between the client application and Cassandra (it does not control which node a client connects to). Snitches are configured for a Cassandra cluster in the cassandra.yaml configuration file. All nodes in a cluster should use the same snitch configuration. When assigning tokens, assign them to alternating racks. For example: rack1, rack2, rack3, rack1, rack2, rack3, and so on.
17
SimpleSnitch
The SimpleSnitch (the default) is appropriate if you have no rack or data center information available. Single-data center deployments (or single-zone in public clouds) usually fall into this category. If using this snitch, use replication_factor=<#> when defining your keyspace strategy_options. This snitch does not recognize data center or rack information.
DseSimpleSnitch
DseSimpleSnitch is used in DataStax Enterprise (DSE) deployments only. It logically configures Hadoop analytics nodes in a separate data center from pure Cassandra nodes in order to segregate analytic and real-time workloads. It can be used for mixed-workload DSE clusters located in one physical data center. It can also be used for multi-data center DSE clusters that have exactly 2 data centers, with all analytic nodes in one data center and all Cassandra real-time nodes in another data center. If using this snitch, use Analytics or Cassandra as your data center names when defining your keyspace strategy_options.
RackInferringSnitch
RackInferringSnitch infers the topology of the network by analyzing the node IP addresses. This snitch assumes that the second octet identifies the data center where a node is located, and the third octet identifies the rack.
18
If using this snitch, use the second octet number of your node IPs as your data center names when defining your keyspace strategy_options. For example, 100 would be the data center name.
PropertyFileSnitch
PropertyFileSnitch determines the location of nodes by referring to a user-defined description of the network details located in the property file cassandra-topology.properties. This snitch is best when your node IPs are not uniform or you have complex replication grouping requirements. See Configuring the PropertyFileSnitch for more information. If using this snitch, you can define your data center names to be whatever you want. Just make sure the data center names you define in the cassandra-topology.properties file correlates to what you name your data centers in your keyspace strategy_options.
EC2Snitch
EC2Snitch is for simple cluster deployments on Amazon EC2 where all nodes in the cluster are within the same region. Instead of using the node's IP address to infer node location, this snitch uses the AWS API to request the region and availability zone of a node. The region is treated as the data center and the availability zones are treated as racks within the data center. For example, if a node is in us-east-1a, us-east is the data center name and 1a is the rack location. If using this snitch, use the EC2 region name (for example,``us-east``) as your data center name when defining your keyspace strategy_options.
EC2MultiRegionSnitch
EC2MultiRegionSnitch is for cluster deployments on Amazon EC2 where the cluster spans multiple regions. Instead of using the node's IP address to infer node location, this snitch uses the AWS API to request the region and availability zone of a node. Regions are treated as data centers and availability zones are treated as racks within a data center. For example, if a node is in us-east-1a, us-east is the data center name and 1a is the rack location. If using this snitch, you must configure each Cassandra node so that listen_address is set to the private IP address or the node, and broadcast_address is set to the public IP address of the node. This allows Cassandra nodes in one EC2 region to bind to nodes in another region, thus enabling multi-data center support. If using this snitch, use the EC2 region name (for example,``us-east``) as your data center names when defining your keyspace strategy_options.
Understanding the Cassandra Architecture All nodes in Cassandra are peers. A client read or write request can go to any node in the cluster. When a client connects to a node and issues a read or write request, that node serves as the coordinator for that particular client operation. The job of the coordinator is to act as a proxy between the client application and the nodes (or replicas) that own the data being requested. The coordinator determines which nodes in the ring should get the request based on the cluster configured partitioner and replica placement strategy.
Also see About Writes in Cassandra for more information about how Cassandra processes writes locally at the node level.
20
Understanding the Cassandra Architecture In multi data center deployments, Cassandra optimizes write performance by choosing one coordinator node in each remote data center to handle the requests to replicas within that data center. The coordinator node contacted by the client application only needs to forward the write request to one node in each remote data center. If using a consistency level of ONE or LOCAL_QUORUM, only the nodes in the same data center as the coordinator node must respond to the client request in order for the request to succeed. This way, geographical latency does not impact client request response times.
21
Also see About Reads in Cassandra for more information about how Cassandra processes reads locally at the node level.
Memory
The more memory a Cassandra node has, the better read performance. More RAM allows for larger cache sizes and reduces disk I/O for reads. More RAM also allows memory tables (memtables) to hold more recently written data. Larger memtables lead to a fewer number of SSTables being flushed to disk and fewer files to scan during a read. The ideal amount of RAM depends on the anticipated size of your hot data. For dedicated hardware, a minimum of than 8GB of RAM is needed. DataStax recommends 16GB - 32GB. Java heap space should be set to a maximum of 8GB or half of your total RAM, whichever is lower. (A greater heap size has more intense garbage collection periods.) For a virtual environment use a minimum of 4GB, such as Amazon EC2 Large instances. For production clusters with a healthy amount of traffic, 8GB is more common.
22
CPU
Insert-heavy workloads are CPU-bound in Cassandra before becoming memory-bound. Cassandra is highly concurrent and uses as many CPU cores as available. For dedicated hardware, 8-core processors are the current price-performance sweet spot. For virtual environments, consider using a provider that allows CPU bursting, such as Rackspace Cloud Servers.
Disk
What you need for your environment depends a lot on the usage, so it's important to understand the mechanism. Cassandra writes data to disk for two purposes: All data is written to the commit log for durability. When thresholds are reached, Cassandra periodically flushes in-memory data structures (memtables) to SSTable data files for persistent storage of column family data. Commit logs receive every write made to a Cassandra node, but are only read during node start up. Commit logs are purged after the corresponding data is flushed. Conversely, SSTable (data file) writes occur asynchronously and are read during client look-ups. Additionally, SSTables are periodically compacted. Compaction improves performance by merging and rewriting data and discarding old data. However, during compaction (or node repair), disk utilization and data directory volume can substantially increase. For this reason, DataStax recommends leaving an adequate amount of free disk space available on a node (50% [worst case] for tiered compaction, 10% for leveled compaction). Recommendations: When choosing disks, consider both capacity (how much data you plan to store) and I/O (the write/read throughput rate). Most workloads are best served by using less expensive SATA disks and scaling disk capacity and I/O by adding more nodes (with more RAM). Solid-state drives (SSDs) are also a valid alternative for Cassandra. Cassandra's sequential, streaming write patterns minimize the undesirable effects of write amplification associated with SSDs. Ideally Cassandra needs at least two disks, one for the commit log and the other for the data directories. At a minimum the commit log should be on its own partition. Commit log disk - this disk does not need to be large, but it should be fast enough to receive all of your writes as appends (sequential I/O). Data disks - use one or more disks and make sure they are large enough for the data volume and fast enough to both satisfy reads that are not cached in memory and to keep up with compaction. RAID - compaction can temporarily require up to 100% of the free in-use disk space on a single data directory volume. This means when approaching 50% of disk capacity, you should use RAID 0 or RAID 10 for your data directory volumes. RAID also helps smooth out I/O hotspots within a single SSTable. Use RAID0 if disk capacity is a bottleneck and rely on Cassandra's replication capabilities for disk failure tolerance. If you lose a disk on a node, you can recover lost data through Cassandra's built-in repair. Use RAID10 to avoid large repair operations after a single disk failure, or if you have disk capacity to spare. Because data is stored in the memtable, generally RAID is not needed for the commit log disk, but if you need the extra redundancy, use RAID 1. Extended file systems - On ext2 or ext3, the maximum file size is 2TB even using a 64-bit kernel. On ext4 it is 16TB. Because Cassandra can use almost half your disk space for a single file, use XFS when raiding large disks together, particularly if using a 32-bit kernel. XFS file size limits are 16TB max on a 32-bit kernel, and essentially unlimited on 64-bit.
Number of Nodes
23
Understanding the Cassandra Architecture The amount of data on each disk in the array isn't as important as the total size per node. Using a greater number of smaller nodes is better than using fewer larger nodes because of potential bottlenecks on larger nodes during compaction.
Network
Since Cassandra is a distributed data store, it puts load on the network to handle read/write requests and replication of data across nodes. Be sure to choose reliable, redundant network interfaces and make sure that your network can handle traffic between nodes without bottlenecksT. Recommended bandwith is 1000 Mbit/s (Gigabit) or greater. Bind the Thrift interface (listen_address) to a specific NIC (Network Interface Card). Bind the RPC server inteface (rpc_address) to another NIC. Cassandra is efficient at routing requests to replicas that are geographically closest to the coordinator node handling the request. Cassandra will pick a replica in the same rack if possible, and will choose replicas located in the same data center over replicas in a remote data center. Cassandra uses the following ports. If using a firewall, make sure that nodes within a cluster can reach each other on these ports: Port 7000 9160 7199 Cassandra intra-node communication port Thrift client port JMX monitoring port (8080 in prior releases) Description
Understanding the Cassandra Architecture volume. Start with the raw capacity of the physical disks: raw_capacity = disk_size * number_of_disks Account for file system formatting overhead (roughly 10 percent) and the RAID level you are using. For example, if using RAID-10, the calculation would be: (raw_capacity * 0.9) / 2 = formatted_disk_space During normal operations, Cassandra routinely requires disk capacity for compaction and repair operations. For optimal performance and cluster health, DataStax recommends that you do not fill your disks to capacity, but run at 50-80 percent capacity. With this in mind, calculate the usable disk space as follows (example below uses 50%): formatted_disk_space * 0.5 = usable_disk_space
Storage Settings
By default, a node is configured to store the data it manages in /var/lib/cassandra. In a production cluster deployment, you should change the commitlog_directory so it is on a different disk device than the data_file_directories.
Gossip Settings
25
Understanding the Cassandra Architecture The gossip settings control a nodes participation in a cluster and how the node is known to the cluster. Property cluster_name listen_address seeds Description Name of the cluster that this node is joining. Should be the same for every node in the cluster. The IP address or hostname that other Cassandra nodes will use to connect to this node. Should be changed from localhost to the public address for the host. A comma-delimited list of node IP addresses used to bootstrap the gossip process. Every node should have the same list of seeds. In multi data center clusters, the seed list should include a node from each data center. The intra-node communication port (default is 7000). Should be the same for every node in the cluster. The initial token is used to determine the range of data this node is responsible for.
Gossip information is also persisted locally by each node to use immediately next restart without having to wait for gossip. To clear gossip history on node restart (for example, if node IP addresses have changed), add the following line to the cassandra-env.sh file. This file is located in /usr/share/cassandra or $CASSANDRA_HOME/conf. -Dcassandra.load_ring_state=false
Partitioner Settings
When you deploy a Cassandra cluster, you need to make sure that each node is responsible for roughly an equal amount of data. This is also known as load balancing. This is done by configuring the partitioner for each node, and correctly assigning the node an initial_token value. DataStax strongly recommends using the RandomPartitioner (the default) for all cluster deployments. Assuming use of this partitioner, each node in the cluster is assigned a token that represents a hash value within the range of 0 to 2**127. For clusters where all nodes are in a single data center, you can calculate tokens by dividing the range by the total number of nodes in the cluster. In multi data-center deployments, tokens should be calculated such that each data center is individually load balanced as well. See Calculating Tokens for the different approaches to generating tokens for nodes in single and multi-data center clusters.
Snitch Settings
The snitch is responsible for knowing the location of nodes within your network topology. This affects where replicas are placed as well as how requests are routed between replicas. The endpoint_snitch property configures the snitch for a node. All nodes should have the exact same snitch configuration. For a single data center (or single node) cluster, using the default SimpleSnitch is usually sufficient. However, if you plan to expand your cluster at a later time to multiple racks and data centers, it will be easier if you choose a rack and data center aware snitch from the start. All snitches are compatible with all replica placement strategies. Configuring the PropertyFileSnitch The PropertyFileSnitch allows you to define your data center and rack names to be whatever you want. Using this snitch requires you to define network details for each node in the cluster in a cassandra-topology.properties configuration file. This file is located in /etc/cassandra/conf/cassandra.yaml in packaged installations or $CASSANDRA_HOME/conf/cassandra.yaml in binary installations. Every node in the cluster should be described in this file, and this file should be exactly the same on every node in the cluster.
26
Understanding the Cassandra Architecture For example, supposing you had non-uniform IPs and two physical data centers with two racks in each, and a third logical data center for replicating analytics data: # Data Center One 175.56.12.105=DC1:RAC1 175.50.13.200=DC1:RAC1 175.54.35.197=DC1:RAC1 120.53.24.101=DC1:RAC2 120.55.16.200=DC1:RAC2 120.57.102.103=DC1:RAC2 # Data Center Two 110.56.12.120=DC2:RAC1 110.50.13.201=DC2:RAC1 110.54.35.184=DC2:RAC1 50.33.23.120=DC2:RAC2 50.45.14.220=DC2:RAC2 50.17.10.203=DC2:RAC2 # Analytics Replication Group 172.106.12.120=DC3:RAC1 172.106.12.121=DC3:RAC1 172.106.12.122=DC3:RAC1 # default for unknown nodes default=DC3:RAC1 Make sure the data center names you define in the cassandra-topology.properties file correlates to what you name your data centers in your keyspace strategy_options.
27
Installing and Initializing a Cassandra Cluster When declaring the keyspace strategy_options, what you name your data centers depends on the snitch you have chosen for your cluster. The data center names must correlate to the snitch you are using in order for replicas to be placed in the correct location. As a general rule, the number of replicas should not exceed the number of nodes in a replication group. However, it is possible to increase the number of replicas, and then add the desired number of nodes afterwards. When the replication factor exceeds the number of nodes, writes will be rejected, but reads will still be served as long as the desired consistency level can be met.
Note
By downloading community software from DataStax you agree to the terms of the DataStax Community EULA (End User License Agreement) posted on the DataStax web site.
28
1. (CentOS only) Make sure you have EPEL (Extra Packages for Enterprise Linux) installed. EPEL contains dependent packages required by DSE, such as jna and jpackage-utils: For 32-bit systems: $ sudo rpm http://download.fedora.redhat.com/pub/epel/5/i386/epel-release-5-4.noarch.rpm For 64-bit systems: $ sudo rpm -Uvh http://download.fedoraproject.org/pub/epel/5/x86_64/epel-release-5-4.noarch.rpm 2. Add a yum repository specification for the DataStax repository in /etc/yum.repos.d. For example: $ sudo vi /etc/yum.repos.d/datastax.repo 3. In this file add the following lines for the DataStax repository: [datastax] name= DataStax Repo for Apache Cassandra baseurl=http://rpm.datastax.com/community enabled=1 gpgcheck=0 4. Install the package using yum. $ sudo yum install dsc This installs the Cassandra, DataStax Community demos, and OpsCenter packages. -Uvh
29
6. Make sure your system is now using the correct JRE. For example: $ java -version java version "1.6.0_25" Java(TM) SE Runtime Environment (build 1.6.0_25-b06) Java HotSpot(TM) 64-Bit Server VM (build 20.0-b11, mixed mode) 7. If the OpenJDK JRE is still being used, use the alternatives command to switch it. For example: $ sudo alternatives --config java There are 2 programs which provide 'java'. Selection Command ----------------------------------------------1 /usr/lib/jvm/jre-1.6.0-openjdk.x86_64/bin/java *+ 2 /usr/java/jre1.6.0_25/bin/java Enter to keep the current selection[+], or type selection number: 2
Note
By downloading community software from DataStax you agree to the terms of the DataStax Community EULA (End User License Agreement) posted on the DataStax web site. 1. Edit the aptitude repository source list file (/etc/apt/sources.list). $ sudo vi /etc/apt/sources.list 2. In this file, add the DataStax Community repository. deb http://debian.datastax.com/community stable main (Debian Systems Only) Find the line that describes your source repository for Debian and add contrib non-free to the end of the line. This will allow installation of the Oracle JVM instead of the OpenJDK JVM. For example: deb http://some.debian.mirror/debian/ $distro main contrib non-free Save and close the file when you are done adding/editing your sources. 3. Add the DataStax repository key to your aptitude trusted keys. $ wget -O - http://debian.datastax.com/debian/repo_key | sudo apt-key add 4. Install the package. $ sudo apt-get update $ sudo apt-get install dsc This installs the Cassandra, DataStax Community demos, and OpsCenter packages.
30
6. Check which version of the Java Runtime Environment (JRE) your system is using. If your system is using the OpenJDK Runtime Environment, you will need to change it to use the Oracle JRE. $ java -version 7. By default, the Debian packages start the Cassandra service automatically. To stop the service and clear the initial gossip history that gets populated by this initial start: $ sudo service cassandra stop $ sudo bash -c 'rm /var/lib/cassandra/data/system/*'
Note
The Oracle Java Runtime Environment (SRE) has been removed from the official software repositories of Ubuntu and only provides a binary (.bin) version. You can get the JRE from the Java SE Downloads. 1. Download the appropriate version of the JRE, such as jre-6u31-linux-i586.bin, for your system and unpack it directly under /opt/java/<32 or 64>. 2. Make the file executable: sudo chmod 755 /opt/java/32/jre-6u31-linux-i586.bin 3. Go to the new folder: cd /opt/java 4. Execute the file: sudo ./jre-6u31-linux-i586.bin 5. Accept the license terms to continue installing the JRE. 6. Tell the system that there's a new Java version available:
sudo update-alternatives --install "/usr/bin/java" "java" "/opt/java/32/jre1.6.0_31/bin/java" 1
Note
If updating from a previous version that was removed manually, execute the above command twice, because you'll get an error message the first time. 7. Set the new JRE as the default: sudo update-alternatives --set java /opt/java/32/jre1.6.0_31/bin/java 8. Make sure your system is now using the correct JRE: $ sudo java -version java version "1.6.0_31" Java(TM) SE Runtime Environment (build 1.6.0_31-b04) Java HotSpot(TM) 64-Bit Server VM (build 20.1-b04, mixed mode)
31
Installing and Initializing a Cassandra Cluster The packaged releases install into the following directories. The packaged releases create a cassandra user. When starting Cassandra as a service, the service runs as this user. /var/lib/cassandra (data directories) /var/log/cassandra (log directory) /var/run/cassandra (runtime files) /usr/share/cassandra (environment settings) /usr/share/dse-demos (DataStax demo application) /usr/share/cassandra/lib (jar files) /usr/bin (binary files) /usr/sbin /etc/cassandra (configuration files) /etc/init.d (service startup script) /etc/security/limits.d (cassandra user limits) /etc/default
Next Steps
For next steps see Configuring and Starting a Cassandra Cluster.
Note
By downloading community software from DataStax you agree to the terms of the DataStax Community EULA (End User License Agreement) posted on the DataStax web site. 1. Download the distribution to a location on your machine and unpack it. For example, to download and unpack Cassandra DataStax Community, you enter the following command: $ wget http://downloads.datastax.com/community/dsc.tar.gz $ tar -xvzf dsc.tar.gz 2. For convenience, set the following environment variables in your user environment (such as .bashrc): export CASSANDRA_HOME=<install_location>/<dse_package_name> export PATH=$PATH:$CASSANDRA_HOME/bin
32
3. Create the data and logging directories needed by Cassandra. By default, Cassandra uses /var/lib/cassandra and /var/log/cassandra. To create these directories, run the following commands where $USER is the user that will run Cassandra: # # # # mkdir mkdir chown chown /var/lib/cassandra /var/log/cassandra -R $USER:$GROUP /var/lib/cassandra -R $USER:$GROUP /var/log/cassandra
Note
For information about installing the Portfolio Demo Sample Application, see Installing a Single-Node Instance of Cassandra.
Installing JNA
Installing JNA (Java Native Access) on Linux platforms can improve Cassandra memory usage. With JNA installed and configured as described in this section, Linux does not swap out the JVM, and thus avoids related performance issues.
Note
JNA is not required on Windows. 1. Download jna.jar from the JNA project site. 2. Add jna.jar to $CASSANDRA_HOME/lib/ or otherwise place it on the CLASSPATH. 3. Edit the file /etc/security/limits.conf, adding the following entries for the user or group that runs Cassandra: $USER soft memlock unlimited $USER hard memlock unlimited
Next Steps
For next steps see Configuring and Starting a Cassandra Cluster.
33
Installs Cassandra on an Ubuntu 10.10 image Uses RAID0 ephemeral disks for data storage and commit log Uses the private interface for intra-cluster communication Configures a Cassandra cluster using the RandomPartitioner Configures the Cassandra replication strategy using the EC2Snitch Configures the seed node cluster-wide Starts Cassandra on all the nodes Installs DataStax OpsCenter on the first node in the cluster (by default)
3. Click Inbound and add rules for the following ports. Port 22 7000 9160 7199 1024+ 8888 61620 61621 8983 SSH Custom TCP Rule Custom TCP Rule Custom TCP Rule Custom TCP Rule Custom TCP Rule Custom TCP Rule Custom TCP Rule Custom TCP Rule Rule Type Default SSH port Cassandra intra-node port (source is the current security group, shown in Details tab) Cassandra client port Cassandra JMX monitoring port JMX reconnection/loopback ports (source is the current security group) OpsCenter website port OpsCenter intra-node monitoring port (source is the current security group) OpsCenter agent port (source is the current security group) DataStax demo application website port Description
34
4. After you are done adding the above port rules, click Apply Rule Changes. Your completed port rules should look something like this:
Note
This security configuration shown in this example opens up all externally accessible ports to incoming traffic from any IP address (0.0.0.0/0). If you desire a more secure configuration, see the Amazon EC2 help on Security Groups for more information on how to configure more limited access to your cluster.
35
5. On the next page, under Advanced Instance Options, add the following options to the User Data section according to the type of cluster you want, and then click Continue. For new Cassandra clusters the available options are: Option -c | --clustername <name> -n | --totalnodes <num_nodes> -v | --version [enterprise | community] -o | --opscenter [no] -e | --email <smtp>:<port>:<email>:<password> Description Required. The name of the cluster. Required. The total number of nodes in the cluster. Required. The version of the cluster. Use community to install the latest version of DataStax Community Edition. Optional. By default, DataStax OpsCenter is installed on the first instance unless you specify this option with no. Optional. Sends logs from AMI install to this email address. (Option parameters cannot have spaces.)
For example, -c mycluster -n 6 -v community -e smtp.gmail.com:587:ec2@datastax.com:pa$$word Option parameters cannot have spaces.
6. On the Tags page, give a name to your instance, such as cassandra-node, and then click Continue. 7. On the Create Key Pair page, create a new key pair or select an existing key pair, and then click Continue. You will need this key (.pem file) to log in to your Cassandra nodes, so save it to a location on your local machine. 8. On the Configure Firewall page, select the security group you created earlier and click Continue. 9. On the Review page, review your cluster configuration and then click Launch. 10. Close the Launch Install Wizard and go to the My Instances page to see the status of your instance. Once a node has a status of running, you are able to connect to it.
36
1. From the My Instances page in your AWS EC2 Dashboard, select the node you want to connect to. Since all nodes are peers in Cassandra, you can connect using any node in the cluster. However, the first node is typically the node running the OpsCenter service (and is also the Cassandra seed node).
2. To get the public DNS name of a node, select Instance Actions > Connect
37
3. This will open a Connect Help - Secure Shell (SSH) page for the selected node. This page contains all of the information you need to connect via SSH.
Note
If you copy and paste the command line, change the connection user from root to ubuntu.
4. The AMI image configures your cluster and starts the Cassandra and OpsCenter services. After you have logged in to a node, run the nodetool ring command to make sure your cluster is up and running. For example: nodetool ring -h localhost
5. For next steps, see Running the Portfolio Demo Sample Application.
38
Note
If you installed OpsCenter with your Cassandra cluster, allow about 60 to 90 seconds after the cluster has finished loading for OpsCenter to start. You can launch OpsCenter using the URL: http://<public-dns-of-first-instance>:8888. (To find the Public DSN of an instance, select the instance. The DNS is displayed at the top of the details section.) After OpsCenter loads, you must install the OpsCenter agents to see the cluster performance data (click Install Agents). When prompted for credentials for the agent nodes, use the username ubuntu and copy/paste the entire contents from your private key file ( the .pem file you downloaded earlier).
39
cluster_name: 'MyDemoCluster' initial_token: 0 seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "110.82.155.0,110.82.155.3" listen_address: 110.82.155.0 rpc_address: 0.0.0.0 endpoint_snitch: RackInferringSnitch node1 cluster_name: 'MyDemoCluster' initial_token: 28356863910078205288614550619314017621 seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "110.82.155.0,110.82.155.3" listen_address: 110.82.155.1 rpc_address: 0.0.0.0 endpoint_snitch: RackInferringSnitch node2 cluster_name: 'MyDemoCluster' initial_token: 56713727820156410577229101238628035242 seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "110.82.155.0,110.82.155.3" listen_address: 110.82.155.2 rpc_address: 0.0.0.0 endpoint_snitch: RackInferringSnitch node3 cluster_name: 'MyDemoCluster' initial_token: 85070591730234615865843651857942052864 seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "110.82.155.0,110.82.155.3" listen_address: 110.82.155.3 rpc_address: 0.0.0.0 endpoint_snitch: RackInferringSnitch node4 cluster_name: 'MyDemoCluster' initial_token: 113427455640312821154458202477256070485 seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "110.82.155.0,110.82.155.3" listen_address: 110.82.155.4 rpc_address: 0.0.0.0 endpoint_snitch: RackInferringSnitch
40
Installing and Initializing a Cassandra Cluster node5 cluster_name: 'MyDemoCluster' initial_token: 141784319550391026443072753096570088106 seed_provider: - class_name: org.apache.cassandra.locator.SimpleSeedProvider parameters: - seeds: "110.82.155.0,110.82.155.3" listen_address: 110.82.155.5 rpc_address: 0.0.0.0 endpoint_snitch: RackInferringSnitch
Calculating Tokens
Tokens are used to assign a range of data to a particular node. Assuming you are using the RandomPartitioner (the default partitioner), the approaches described in this section will ensure even data distribution. Each node in the cluster should be assigned a token before it is started for the first time. The token is set with the initial_token property in the cassandra.yaml configuration file.
41
2. Paste the following Python program into this file: #! /usr/bin/python import sys if (len(sys.argv) > 1): num=int(sys.argv[1]) else: num=int(raw_input("How many nodes are in your cluster? ")) for i in range(0, num): print 'token %d: %d' % (i, (i*(2**127)/num)) 3. Save and close the file and make it executable: chmod +x tokengentool 4. Run the script: ./tokengentool 5. When prompted, enter the total number of nodes in your cluster: How many token 0: token 1: token 2: token 3: token 4: token 5: nodes are in your cluster? 6 0 28356863910078205288614550619314017621 56713727820156410577229101238628035242 85070591730234615865843651857942052864 113427455640312821154458202477256070485 141784319550391026443072753096570088106
6. On each node, edit the cassandra.yaml file and enter its corresponding token value in the initial_token property.
42
Another way to assign tokens in a multi data center cluster is to generate tokens for the nodes in one data center, and then offset those token numbers by 1 for all nodes in the next data center, by 2 for the nodes in the next data center, and so on. This approach is good if you are adding a data center to an established cluster, or if your data centers do not have the same number of nodes.
Installing and Initializing a Cassandra Cluster After you have installed and configured Cassandra on all nodes, you are ready to start your cluster. On initial start-up, each node must be started one at a time, starting with your seed nodes. Packaged installations include startup scripts for running Cassandra as a service. Binary packages do not. Starting/Stopping Cassandra as a Stand-Alone Process Starting/Stopping Cassandra as a Service
Note
On Enterprise Linux systems, the Cassandra service runs as a java process. On Debian systems, the Cassandra service runs as a jsvc process.
Upgrading Cassandra
This section includes information on upgrading between releases: Major Releases Upgrading Cassandra: 0.8.x to 1.0.x Minor Releases Upgrading Between Minor Releases of Cassandra 1.0.x
44
Always take a snapshot before any upgrade. This allows you to rollback to the previous version if necessary. Cassandra is able to read data files created by the previous version, but the inverse is not always true.
Note
Snapshotting is fast, especially if you have JNA installed, and takes effectively zero disk space until you start compacting the live data files again. Be sure to check https://github.com/apache/cassandra/blob/trunk/NEWS.txt for any new information on upgrading. For a list of fixes and new features, see https://github.com/apache/cassandra/blob/trunk/CHANGES.txt
4. Run nodetool drain on the 0.8.x node to flush the commit log. 5. Restart the Cassandra process. 6. Monitor the log files for any issues. 7. After upgrading and restarting all Cassandra processes, restart client applications. 8. After upgrading, run nodetool upgradesstables against each node before running repair, moving nodes, or adding new ones. (If using Cassandra 1.0.3 and earlier, use nodetool scrub instead.)
compaction_thread_priority Removed (use compaction_throughput_mb_per_sec instead) commitlog_rotation_threshold_in_mb Removed commitlog_total_space_in_mb (replaces column family storage property memtable_flush_after_mins) 4096 multithreaded_compaction false memtable_total_space_in_mb of heap (replaces column family storage properties memtable_operations_in_millions 1/3 and memtable_throughput_in_mb) 0.8 Release seed_provider seeds SimpleSeedProvider Note: Now a comma-delimited list in double quotes.
memtable_total_space_in_mb of heap 1/3 compaction_throughput_mb_per_sec 16 concurrent_compactors internode_encryption keystore keystore_password truststore truststore_password One per CPU none conf/.keystore cassandra conf/.truststore cassandra
46
4. Flush the commit log on the upgraded node by running nodetool drain. 5. Stop the old Cassandra process, then start the new binary process. 6. Monitor the log files for any issues. To upgrade a Debian or RPM package installation: 1. On each node, download and install the package from the downloads section of the Cassandra website. 2. Account for New and Changed Parameters between 0.8 and 1.0 in cassandra.yaml. You can copy your existing configuration file into the upgraded Cassandra instance and manually update it with new content. 3. Make sure any client drivers, such as Hector or Pycassa clients, are compatible with the new version. 4. Flush the commit log on the upgraded node by running nodetool drain. 5. Restart the Cassandra process. 6. Monitor the log files for any issues.
47
In Cassandra, the keyspace is the container for your application data, similar to a database or schema in a relational database. Inside the keyspace are one or more column family objects, which are analogous to tables. Column families contain columns, and a set of related columns is identified by an application-supplied row key. Each row in a column family is not required to have the same set of columns. Cassandra does not enforce relationships between column families the way that relational databases do between tables: there are no formal foreign keys in Cassandra, and joining column families at query time is not supported. Each column family has a self-contained set of columns that are intended to be accessed together to satisfy specific queries from your application. For example, using the blog application example, you might have a column family for user data and blog entries similar to the relational model. Other column families (or secondary indexes) could then be added to support the queries your application needs to perform. For example, to answer the queries "what users subscribe to my blog" or "show me all of the blog entries about fashion" or "show me the most recent entries for the blogs I subscribe to", you would need to design additional column families (or add secondary indexes) to support those queries. Keep in mind that some denormalization of data is usually required.
48
About Keyspaces
In Cassandra, the keyspace is the container for your application data, similar to a schema in a relational database. Keyspaces are used to group column families together. Typically, a cluster has one keyspace per application. Replication is controlled on a per-keyspace basis, so data that has different replication requirements should reside in different keyspaces. Keyspaces are not designed to be used as a significant map layer within the data model, only as a way to control data replication for a set of column families.
Defining Keyspaces
49
Understanding the Cassandra Data Model Data Definition Language (DDL) commands for defining and altering keyspaces are provided in the various client interfaces, such as Cassandra CLI and CQL. For example, to define a keyspace in CQL: CREATE KEYSPACE keyspace_name WITH strategy_class = 'SimpleStrategy' AND strategy_options:replication_factor=2; Or in Cassandra CLI: CREATE KEYSPACE keyspace_name WITH placement_strategy = 'SimpleStrategy' AND strategy_options = [{replication_factor:2}]; See Getting Started Using the Cassandra CLI and Getting Started with CQL for more information on DDL commands for Cassandra.
A dynamic column family takes advantage of Cassandra's ability to use arbitrary application-supplied column names to store data. A dynamic column family allows you to pre-compute result sets and store them in a single row for efficient data retrieval. Each row is a snapshot of data meant to satisfy a given query, sort of like a materialized view. For example, a column family that tracks the users that subscribe to a particular user's blog.
50
Instead of defining metadata for individual columns, a dynamic column family defines the type information for column names and values (comparators and validators), but the actual column names and values are set by the application when a column is inserted. For all column families, each row is uniquely identified by its row key, similar to the primary key in a relational table. A column family is always partitioned on its row key, and the row key is always implicitly indexed.
About Columns
The column is the smallest increment of data in Cassandra. It is a tuple containing a name, a value and a timestamp.
A column must have a name, and the name can be a static label (such as "name" or "email") or it can be dynamically set when the column is created by your application. Columns can be indexed on their name (see secondary indexes). However, one limitation of column indexes is that they do not support queries that require access to ordered data, such as time series data. In this case a secondary index on a timestamp column would not be sufficient because you cannot control column sort order with a secondary index. For cases where sort order is important, manually maintaining a column family as an 'index' is another way to lookup column data in sorted order. It is not required for a column to have a value. Sometimes all the information your application needs to satisfy a given query can be stored in the column name itself. For example, if you are using a column family as a materialized view to lookup rows from other column families, all you need to store is the row key that you are looking up; the value can be empty. Cassandra uses the column timestamp to determine the most recent update to a column. The timestamp is provided by the client application. The latest timestamp always wins when requesting data, so if multiple client sessions update the same columns in a row concurrently, the most recent update is the one that will eventually persist. See About Transactions and Concurrency Control for more information about how Cassandra handles conflict resolution.
51
Understanding the Cassandra Data Model You can use either CLI or CQL to set the TLL for a column. See Setting an Expiring Column and Specifying Column Expiration with TTL. If you want to change the TTL of an expiring column, you have to re-insert the column with a new TTL. In Cassandra the insertion of a column is actually an insertion or update operation, depending on whether or not a previous version of the column exists. This means that to update the TTL for a column with an unknown value, you have to read the column and then re-insert it with the new TTL value. TTL columns have a precision of one second, as calculated on the server. Therefore, a very small TTL probably does not make much sense. Moreover, the clocks on the servers should be synchronized; otherwise reduced precision could be observed because the expiration time is computed on the primary host that receives the initial insertion but is then interpreted by other hosts on the cluster. An expiring column has an additional overhead of 8 bytes in memory and on disk (to record the TTL and expiration time) compared to standard columns.
Internally, the structure of a counter column is a bit more complex. Cassandra tracks the distributed state of the counter as well as a server-generated timestamp upon deletion of a counter column. For this reason, it is important that all nodes in your cluster have their clocks synchronized using network time protocol (NTP). A counter can be read or written at any of the available consistency levels. However, it's important to understand that unlike normal columns, a write to a counter requires a read in the background to ensure that distributed counter values remain consistent across replicas. If you write at a consistency level of ONE, the implicit read will not impact write latency, hence, ONE is the most common consistency level to use with counters.
A super column is a way to group multiple columns based on a common lookup value. The primary use case for super columns is to denormalize multiple rows from other column families into a single row, allowing for materialized view data retrieval. For example, suppose you wanted to create a materialized view of blog entries for the bloggers that a user follows.
52
One limitation of super columns is that all sub-columns of a super column must be deserialized in order to read a single sub-column value, and you cannot create secondary indexes on the sub-columns of a super column. Therefore, the use of super columns is best suited for use cases where the number of sub-columns is a relatively small number.
About Validators
For all column families, it is best practice to define a default row key validator using the key_validation_class property. For static column families, you should define each column and its associated type when you define the column family using the column_metadata property. For dynamic column families (where column names are not known ahead of time), you should specify a default_validation_class instead of defining the per-column data types. Key and column validators may be added or changed in a column family definition at any time. If you specify an invalid validator on your column family, client requests that respect that metadata will be confused, and data inserts or updates 53
Understanding the Cassandra Data Model that do not conform to the specified validator will be rejected.
About Comparators
Within a row, columns are always stored in sorted order by their column name. The comparator specifies the data type for the column name, as well as the sort order in which columns are stored within a row. Unlike validators, the comparator may not be changed after the column family is defined, so this is an important consideration when defining a column family in Cassandra. Typically, static column family names will be strings, and the sort order of columns is not important in that case. For dynamic column families, however, sort order is important. For example, in a column family that stores time series data (the column names are timestamps), having the data in sorted order is required for slicing result sets out of a row of columns.
Understanding the Cassandra Data Model rewritten and compressed by using nodetool upgradesstables (Cassandra 1.0.4 or later) or nodetool scrub. For example, to create a new column family with compression enabled using the Cassandra CLI, you would do the following: [default@demo] CREATE COLUMN FAMILY users WITH key_validation_class=UTF8Type AND column_metadata = [ {column_name: name, validation_class: UTF8Type} {column_name: email, validation_class: UTF8Type} {column_name: state, validation_class: UTF8Type} {column_name: gender, validation_class: UTF8Type} {column_name: birth_year, validation_class: LongType} ] AND compression_options={sstable_compression:SnappyCompressor, chunk_length_kb:64};
55
Understanding the Cassandra Data Model You can specify the KEYS index type when creating a column definition, or you can add it later to index an existing column. Secondary indexes are built in the background automatically, without blocking reads or writes. For example, in the Cassandra CLI, you can create a secondary index on a column when defining a column family (note the index_type:KEYS specification for the state and birth_year columns): [default@demo] create column family users with comparator=UTF8Type ... and column_metadata=[{column_name: full_name, validation_class: UTF8Type}, ... {column_name: email, validation_class: UTF8Type}, ... {column_name: birth_year, validation_class: LongType, index_type: KEYS}, ... {column_name: state, validation_class: UTF8Type, index_type: KEYS}]; Or you can add an index to an existing column family: [default@demo] update column family users with comparator=UTF8Type ... and column_metadata=[{column_name: full_name, validation_class: UTF8Type}, ... {column_name: email, validation_class: UTF8Type}, ... {column_name: birth_year, validation_class: LongType, index_type: KEYS}, ... {column_name: state, validation_class: UTF8Type, index_type: KEYS}]; Because of the secondary index created for state, its values can then be queried directly for users who live in a given state. For example: [default@demo] get users where state = 'TX';
Denormalize to Optimize
In the relational world, the data model is usually designed up front with the goal of normalizing the data to minimize redundancy. Normalization typically involves creating smaller, well-structured tables and then defining relationships between them. During queries, related tables are joined to satisfy the request. Cassandra does not have foreign key relationships like a relational database does, which means you cannot join multiple column families to satisfy a given query request. Cassandra performs best when the data needed to satisfy a given query is located in the same column family. Try to plan your data model so that one or more rows in a single column family are used to answer each query. This sacrifices disk space (one of the cheapest resources for a server) in order to reduce the number of disk seeks and the amount of network traffic.
56
Managing and Accessing Data in Cassandra rather than return a unique constraint violation.
About Compaction
In the background, Cassandra periodically merges SSTables together into larger SSTables using a process called compaction. Compaction merges row fragments together, removes expired tombstones (deleted columns), and rebuilds primary and secondary indexes. Since the SSTables are sorted by row key, this merge is efficient (no random disk I/O).
57
Managing and Accessing Data in Cassandra Once a newly merged SSTable is complete, the input SSTables are marked as obsolete and eventually deleted by the JVM garbage collection (GC) process. However, during compaction, there is a temporary spike in disk space usage and disk I/O. Compaction impacts read performance in two ways. While a compaction is in progress, it temporarily increases disk I/O and disk utilization which can impact read performance for reads that are not fulfilled by the cache. However, after a compaction has been completed, off-cache read performance improves since there are fewer SSTable files on disk that need to be checked in order to complete a read request. As of Cassandra 1.0, there are two different compaction strategies that you can configure on a column family size-tiered compaction or leveled compaction. See Tuning Compaction for a description of these compaction strategies.
About Deletes
When deleting a row or a column in Cassandra, there are a few things to be aware of that may differ from what one would expect in a relational database.
58
1. Deleted data is not immediately removed from disk. Data that is inserted into Cassandra is persisted to SSTables on disk. Once an SSTable is written, it is immutable (the file is not updated by further DML operations). This means that a deleted column is not removed immediately. Instead a marker called a tombstone is written to indicate the new column status. Columns marked with a tombstone exist for a configured time period (defined by the gc_grace_seconds value set on the column family), and then are permanently deleted by the compaction process after that time has expired. 2. A deleted column can reappear if routine node repair is not run. Marking a deleted column with a tombstone ensures that a replica that was down at the time of delete will eventually receive the delete when it comes back up again. However, if a node is down longer than the configured time period for keeping tombstones (defined by the gc_grace_seconds value set on the column family), then the node can possibly miss the delete altogether, and replicate deleted data once it comes back up again. To prevent deleted data from reappearing, administrators must run regular node repair on every node in the cluster (by default, every 10 days). 3. The row key for a deleted row may still appear in range query results. When you delete a row in Cassandra, it marks all columns for that row key with a tombstone. Until those tombstones are cleared by compaction, you have an empty row key (a row that contains no columns). These deleted keys can show up in results of get_range_slices() calls. If your client application performs range queries on rows, you may want to have if filter out row keys that return empty column lists.
Note
By default, hints are only saved for one hour before they are dropped. If all replicas are down at the time of write, and they all remain down for longer than the configured time of max_hint_window_in_ms, you could potentially lose a write made at consistency level ANY. Hinted handoff does not count towards any other consistency level besides ANY. For example, if using a consistency level of ONE and all replicas for the written row are down, the write will fail regardless of whether a hint is written or not. When a replica that is storing hints detects via gossip that the failed node is alive again, it will begin streaming the missed writes to catch up the out-of-date replica.
Note
Hinted handoff does not completely replace the need for regular node repair operations.
59
Managing and Accessing Data in Cassandra When a read request for a row comes in to a node, the row must be combined from all SSTables on that node that contain columns from the row in question, as well as from any unflushed memtables, to produce the requested data. To optimize this piecing-together process, Cassandra uses an in-memory structure called a bloom filter: each SSTable has a bloom filter associated with it that is used to check if any data for the requested row exists in the SSTable before doing any disk I/O. As a result, Cassandra is very performant on reads when compared to other storage systems, even for read-heavy workloads. As with any database, reads are fastest when the most in-demand data (or hot working set) fits into memory. Although all modern storage systems rely on some form of caching to allow for fast access to hot data, not all of them degrade gracefully when the cache capacity is exceeded and disk I/O is required. Cassandra's read performance benefits from built-in caching, but it also does not dip dramatically when random disk seeks are required. When I/O activity starts to increase in Cassandra due to increased read load, it is easy to remedy by adding more nodes to the cluster. For rows that are accessed frequently, Cassandra has a built-in key cache (and an optional row cache). See Tuning the Cache for more information about optimizing read performance using the built-in caching features. For a detailed explanation of how client read and write requests are handled in Cassandra, also see About Client Requests in Cassandra.
ONE QUORUM
60
LOCAL_QUORUM
A write must be written to the commit log and memory table on a quorum of replica nodes in the same data center as the coordinator node. Avoids latency of inter-data center communication. A write must be written to the commit log and memory table on a quorum of replica nodes in all data centers. A write must be written to the commit log and memory table on all replica nodes in the cluster for that row key.
EACH_QUORUM ALL
EACH_QUORUM ALL
Note
LOCAL_QUORUM and EACH_QUORUM are designed for use in multi-data center clusters using a rack-aware replica placement strategy (such as NetworkTopologyStrategy) and a properly configured snitch.
Choosing Client Consistency Levels Choosing a consistency level for reads and writes involves determining your requirements for consistent results (always reading the most recently written data) versus read or write latency (the time it takes for the requested data to be returned or for the write to succeed). If latency is a top priority, consider a consistency level of ONE (only one replica node must successfully respond to the read or write request). There is a higher probability of stale data being read with this consistency level (as the replicas contacted for reads may not always have the most recent write). For some applications, this may be an acceptable trade-off. If it is an absolute requirement that a write never fail, you may also consider a write consistency level of ANY. This consistency level has the highest probability of a read not returning the latest written values (see hinted handoff).
61
Managing and Accessing Data in Cassandra If consistency is top priority, you can ensure that a read will always reflect the most recent write by using the following formula: (nodes_written + nodes_read) > replication_factor For example, if your application is using the QUORUM consistency level for both write and read operations and you are using a replication factor of 3, then this ensures that 2 nodes are always written and 2 nodes are always read. The combination of nodes written and read (4) being greater than the replication factor (3) ensures strong read consistency. Consistency Levels for Multi-Data Center Clusters A client read or write request to a Cassandra cluster always specifies the consistency level it requires. Ideally, you want a client request to be served by replicas in the same data center in order to avoid latency. Contacting multiple data centers for a read or write request can slow down the response. The consistency level LOCAL_QUORUM is specifically designed for doing quorum reads and writes in multi data center clusters. A consistency level of ONE is also fine for applications with less stringent consistency requirements. A majority of Cassandra users do writes at consistency level ONE. With this consistency, the request will always be served by the replica node closest to the coordinator node that received the request (unless the dynamic snitch determines that the node is performing poorly and routes it elsewhere). Keep in mind that even at consistency level ONE or LOCAL_QUORUM, the write is still sent to all replicas for the written key, even replicas in other data centers. The consistency level just determines how many replicas are required to respond that they received the write. Specifying Client Consistency Levels Consistency level is specified by the client application when a read or write request is made. The default consistency level may differ depending on the client you are using. For example, in CQL the default consistency level for reads and writes is ONE. If you wanted to use QUORUM instead, you could specify that consistency level in the client request as follows: SELECT * FROM users WHERE state='TX' USING CONSISTENCY QUORUM;
Managing and Accessing Data in Cassandra When Cassandra was first released, it originally provided a Thrift RPC-based API as the foundation for client developers to build upon. This proved to be suboptimal: Thrift is too low-level to use without a more idiomatic client wrapping it, and supporting new features (such as secondary indexes in 0.7 and counters in 0.8) became hard to maintain across these clients for many languages. Also, by not having client development hosted within the Apache Cassandra project itself, incompatible clients proliferated in the open source community, all with different levels of stability and features. It became hard for application developers to choose the best API to fit their needs.
About CQL
Cassandra 0.8 was the first release to include the Cassandra Query Language (CQL). As with SQL, clients built on CQL only need to know how to interpret query resultset objects. CQL is the future of Cassandra client API development. CQL drivers are hosted within the Apache Cassandra project.
Note
CQL version 2.0, which has improved support for several commands, is compatible with Cassandra version 1.0 but not version 0.8.x. CQL syntax in based on SQL (Structured Query Language), the standard for relational database manipulation. Although CQL has many similarities to SQL, it does not change the underlying Cassandra data model. There is no support for JOINs, for example. The Python driver includes a command-line interface, cql.sh. See Getting Started with CQL.
63
Note
A command is not sent to the server unless it is terminated by a semicolon (;). Hitting the return key without a semicolon at the end of the line echos an ellipsis ( . . . ), which indicates that the CLI expects more input.
Creating a Keyspace
You can use the Cassandra CLI commands described in this section to create a keyspace. In this example, we create a keyspace called demo, with a replication factor of 1 and using the SimpleStrategy replica placement strategy. Note the single quotes around the string value of placement_strategy: [default@unknown] CREATE KEYSPACE demo with placement_strategy = 'org.apache.cassandra.locator.SimpleStrategy' and strategy_options = [{replication_factor:1}]; You can verify the creation of a keyspace with the SHOW KEYSPACES command. The new keyspace is listed along with the system keyspace and any other existing keyspaces.
64
WITH comparator = UTF8Type AND key_validation_class=UTF8Type AND column_metadata = [ {column_name: full_name, validation_class: UTF8Type} {column_name: email, validation_class: UTF8Type} {column_name: state, validation_class: UTF8Type} {column_name: gender, validation_class: UTF8Type} {column_name: birth_year, validation_class: LongType} ]; Next, create a dynamic column family called blog_entry. Notice that here we do not specify column definitions as the column names are expected to be supplied later by the client application. [default@demo] CREATE COLUMN FAMILY blog_entry WITH comparator = TimeUUIDType AND key_validation_class=UTF8Type AND default_validation_class = UTF8Type;
65
[default@demo] SET users['yomama']['full_name']='Cathy Smith'; [default@demo] SET users['yomama']['state']='CA'; [default@demo] SET users['yomama']['gender']='F'; [default@demo] SET users['yomama']['birth_year']='1969'; In this example, we are creating an entry in the blog_entry column family for row key yomama: [default@demo] SET blog_entry['yomama'][timeuuid()] = 'I love my new shoes!';
Note
The Cassandra CLI uses a default consistency level of ONE for all write and read operations. Specifying different consistency levels is not supported within Cassandra CLI.
66
Managing and Accessing Data in Cassandra For example, suppose we are tracking coupon codes for our users that expire after 10 days. We can define a coupon_code column and set an expiration date on that column. For example: [default@demo] SET users['bobbyjo'] [utf8('coupon_code')] = utf8('SAVE20') WITH ttl=864000; After ten days, or 864,000 seconds have elapsed since the setting of this column, its value will be marked as deleted and no longer be returned by read operations. Note, however, that the value is not actually deleted from disk until normal Cassandra compaction processes are completed.
Indexing a Column
The CLI can be used to create secondary indexes (indexes on column values). You can add a secondary index when you create a column family or add it later using the UPDATE COLUMN FAMILY command. For example, to add a secondary index to the birth_year column of the users column family:
[default@demo] UPDATE COLUMN FAMILY users WITH comparator = UTF8Type AND column_metadata = [{column_name: birth_year, validation_class: LongType, index_type: KEYS}];
Because of the secondary index created for the column birth_year, its values can be queried directly for users born in a given year as follows: [default@demo] GET users WHERE birth_date = 1969;
67
Managing and Accessing Data in Cassandra As of Apache Cassandra version 1.0.5 and DataStax Community version 1.0.1, the cqlsh client is installed with Cassandra in $CASSANDRA_HOME/bin/cqlsh for tarball installations, or /usr/bin/cqlsh for packaged installations. When you start cqlsh, you must provide the IP of a Cassandra node to connect to (default is localhost) and the RPC connection port (default is 9160). For example: $ cqlsh 103.263.89.126 9160 cqlsh> To exit cqlsh type exit at the command prompt. cqlsh> exit
Creating a Keyspace
You can use the cqlsh commands described in this section to create a keyspace. In creating an example keyspace for Twissandra, we will assume a desired replication factor of 3 and implementation of the NetworkTopologyStrategy replica placement strategy. For more information on these keyspace options, see About Replication in Cassandra. Note the single quotes around the string value of strategy_class: cqlsh> CREATE KEYSPACE twissandra WITH strategy_class = 'NetworkTopologyStrategy' AND strategy_options:DC1 = 3;
68
Managing and Accessing Data in Cassandra to insert and retrieve some columns in the users column family. The following commands create and then get a user record for "jsmith." The record includes a value for the password column we created when we created the column family, as well as an expiration time for the password column. Note that the user name "jsmith" is the row key, or in CQL terms, the primary key.
cqlsh> INSERT INTO users (KEY, password) VALUES ('jsmith', 'ch@ngem3a') USING TTL 86400; cqlsh> SELECT * FROM users WHERE KEY='jsmith'; u'jsmith' | u'password',u'ch@ngem3a' | u'ttl', 86400
Indexing a Column
cqlsh can be used to create secondary indexes, or indexes on column values. In this example, we will create an index on the state and birth_year columns in the users column family. cqlsh> CREATE INDEX state_key ON users (state); cqlsh> CREATE INDEX birth_year_key ON users (birth_year); Because of the secondary index created for the two columns, their values can be queried directly as follows:
69
Configuration
cqlsh> SELECT * FROM users ... WHERE gender='f' AND ... state='TX' AND ... birth_year='1968'; u'user1' | u'birth_year',1968 | u'gender',u'f' | u'password',u'ch@ngem3' | u'state',u'TX'
Configuration
Like any modern server-based software, Cassandra has a number of configuration options to tune the system towards specific workloads and environments. Substantial efforts have been made to provide meaningful default configuration values, but given the inherently complex nature of distributed systems coupled with the wide variety of possible workloads, most production deployments will require some modifications of the default configuration.
70
Configuration
commitlog_total_space_in_mb compaction_preheat_key_cache compaction_throughput_mb_per_sec concurrent_compactors concurrent_reads concurrent_writes data_file_directories dynamic_snitch dynamic_snitch_badness_threshold dynamic_snitch_reset_interval_in_ms dynamic_snitch_update_interval_in_ms endpoint_snitch flush_largest_memtables_at hinted_handoff_enabled hinted_handoff_throttle_delay_in_ms in_memory_compaction_limit_in_mb incremental_backups index_interval initial_token internode_encryption keystore keystore_password listen_address max_hint_window_in_ms memtable_flush_queue_size memtable_flush_writers memtable_total_space_in_mb multithreaded_compaction partitioner phi_convict_threshold reduce_cache_capacity_to reduce_cache_sizes_at request_scheduler request_scheduler_id rpc_address rpc_keepalive rpc_max_threads
4096 true 16 One per CPU core 32 32 /var/lib/cassandra/data true 0.0 600000 100 org.apache.cassandra.locator.SimpleSnitch 0.75 true 50 64 false 128 n/a none conf/.keystore cassandra localhost 3600000 (one hour) 4 One per data directory 1/3 of the heap false org.apache.cassandra.dht.RandomPartitioner 8 0.6 0.85 org.apache.cassandra.scheduler.NoScheduler keyspace localhost true Unlimited
71
Configuration
rpc_min_threads rpc_port rpc_recv_buff_size_in_bytes rpc_send_buff_size_in_bytes rpc_server_type rpc_timeout_in_ms saved_caches_directory seeds seed_provider sliced_buffer_size_in_kb snapshot_before_compaction storage_port
16 9160 n/a n/a sync 10000 /var/lib/cassandra/saved_caches 127.0.0.1 org.apache.cassandra.locator.SimpleSeedProvider 64 false 700
auto_bootstrap
When set to true, populates a new node with a range of data when it joins an established cluster based on the setting of initial_token. If initial_token is not set, the newly added node will insert itself into the ring by splitting the token range of the most heavily loaded node. Leave set to false when initializing a brand new cluster.
broadcast_address
If your Cassandra cluster is deployed across multiple Amazon EC2 regions (and you are using the EC2MultiRegionSnitch), you should set broadcast_address to public IP address of the node (and listen_address to the private IP). If not declared, defaults to the same address as specified for listen_address.
cluster_name
The name of the cluster. All nodes participating in a cluster must have the same value.
commitlog_directory
The directory where the commit log will be stored. For optimal write performance, DataStax recommends the commit log be on a separate disk partition (ideally a separate physical device) from the data file directories.
data_file_directories
The directory location where column family data (SSTables) will be stored.
72
Configuration
initial_token
The initial token assigns the node token position in the ring, and assigns a range of data to the node when it first starts up. The initial token can be left unset when introducing a new node to an established cluster using auto_bootstrap. Otherwise, the token value depends on the partitioner you are using. With the random partitioner, this value will be a number between 0 and 2**127. With the byte order preserving partitioner, this value will be a byte array of hex values based on your actual row key values. With the order preserving and collated order preserving partitioners, this value will be a UTF-8 string based on your actual row key values. See Calculating Tokens for more information.
listen_address
The IP address or hostname that other Cassandra nodes will use to connect to this node. If left blank, you must have hostname resolution correctly configured on all nodes in your cluster so that the hostname resolves to the correct IP address for this node (using /etc/hostname, /etc/hosts or DNS).
partitioner
Sets the partitioning method used when assigning a row key to a particular node (also see initial_token). Allowed values are: org.apache.cassandra.dht.RandomPartitioner (default) org.apache.cassandra.dht.ByteOrderedPartitioner org.apache.cassandra.dht.OrderPreservingPartitioner (deprecated) org.apache.cassandra.dht.CollatingOrderPreservingPartitioner (deprecated)
rpc_address
The listen address for remote procedure calls (client connections). To listen on all configured interfaces, set to 0.0.0.0. If left blank, you must have hostname resolution correctly configured on all nodes in your cluster so that the hostname resolves to the correct IP address for this node (using /etc/hostname, /etc/hosts or DNS). Default Value: localhost Allowed Values: An IP address, hostname, or leave unset to resolve the address using the hostname configuration of the node.
rpc_port
The port for remote procedure calls (client connections) and the Thrift service. Default is 9160.
saved_caches_directory
The directory location where column family key and row caches will be stored.
seed_provider
The seed provider is a pluggable interface for providing a list of seed nodes. The default seed provider requires a comma-delimited list of seeds.
seeds
When a node joins a cluster, it contacts the seed node(s) to determine the ring topology and obtain gossip information about the other nodes in the cluster. Every node in the cluster should have the same list of seeds, specified as a comma-delimited list of IP addresses. In multi data center clusters, the seed list should include at least one node from each data center (replication group).
storage_port
The port for inter-node communication. Default port is 7000.
73
Configuration
endpoint_snitch
Sets the snitch to use for locating nodes and routing requests. In deployments with rack-aware replication placement strategies, use either RackInferringSnitch, PropertyFileSnitch, or EC2Snitch (if on Amazon EC2). Has a dependency on the replica placement_strategy, which is defined on a keyspace. The PropertyFileSnitch also requires a cassandra-topology.properties configuration file. Snitches included with Cassandra are: org.apache.cassandra.locator.SimpleSnitch org.apache.cassandra.locator.RackInferringSnitch org.apache.cassandra.locator.PropertyFileSnitch org.apache.cassandra.locator.EC2Snitch
column_index_size_in_kb
Column indexes are added to a row after the data reaches this size. This usually happens if there are a large number of columns in a row or the column values themselves are large. If you consistently read only a few columns from each row, this should be kept small as it denotes how much of the row data must be deserialized to read the column.
commitlog_sync
The method that Cassandra will use to acknowledge writes. The default mode of periodic is used in conjunction with commitlog_sync_period_in_ms to control how often the commit log is synchronized to disk. Periodic syncs are acknowledged immediately. In batch mode, writes are not acknowledged until fsynced to disk. It will wait the configured number of milliseconds for other writes before performing a sync. Allowed Values are periodic (default) or batch.
commitlog_sync_period_in_ms
Determines how often (in milliseconds) to send the commit log to disk when commitlog_sync is set to periodic mode.
commitlog_total_space_in_mb
When the commitlog size on a node exceeds this threshold, Cassandra will flush memtables to disk for the oldest commitlog segments, thus allowing those log segments to be removed. This reduces the amount of data to replay on startup, and prevents infrequently-updated column families from keeping commit log segments around indefinitely. This replaces the per-column family storage setting memtable_flush_after_mins.
compaction_preheat_key_cache
When set to true, cached row keys are tracked during compaction, and re-cached to their new positions in the compacted SSTable. If you have extremely large key caches for your column families, set to false (see the keys_cached attribute set on a column family).
compaction_throughput_mb_per_sec
Throttles compaction to the given total throughput across the entire system. The faster you insert data, the faster you need to compact in order to keep the SSTable count down. The recommended Value is 16-32 times the rate of write throughput (in MBs/second). Setting to 0 disables compaction throttling.
concurrent_compactors
74
Configuration Sets the number of concurrent compaction processes allowed to run simultaneously on a node. Defaults to one compaction process per CPU core.
concurrent_reads
For workloads with more data than can fit in memory, the bottleneck will be reads that need to fetch data from disk. Setting to (16 * number_of_drives) allows operations to queue low enough in the stack so that the OS and drives can reorder them.
concurrent_writes
Writes in Cassandra are almost never I/O bound, so the ideal number of concurrent writes depends on the number of CPU cores in your system. The recommended value is (8 * number_of_cpu_cores).
flush_largest_memtables_at
When Java heap usage after a full concurrent mark sweep (CMS) garbage collection is higher than this percentage, the largest memtables will be flushed to disk in order to free memory. This parameter serves as more of an emergency measure for preventing sudden out-of-memory (OOM) errors rather than a strategic tuning mechanism. It is most effective under light to moderate load, or read-heavy workloads. The default value of .75 means flush memtables when Java heap usage is above 75 percent total heap size. 1.0 disables this feature.
in_memory_compaction_limit_in_mb
Size limit for rows being compacted in memory. Larger rows spill to disk and use a slower two-pass compaction process. When this occurs, a message is logged specifying the row key. The recommended value is 5 to 10 percent of the available Java heap size.
index_interval
Each SSTable has an index file containing row keys and the position at which that row starts in the data file. At startup, Cassandra reads a sample of that index into memory. By default 1 row key out of every 128 is sampled. To find a row, Cassandra performs a binary search on the sample, then does just one disk read of the index block corresponding to the closest sampled entry. The larger the sampling, the more effective the index is (at the cost of memory usage). A smaller value for this property results in a larger, more effective index. Generally, a value between 128 and 512 in combination with a large column family key cache offers the best trade off between memory usage and performance. You may want to increase the sample size if you have small rows, thus decreasing the index size and memory usage. For large rows, decreasing the sample size may improve read performance.
memtable_flush_queue_size
The number of full memtables to allow pending flush, that is, waiting for a writer thread. At a minimum, this should be set to the maximum number of secondary indexes created on a single column family.
memtable_flush_writers
Sets the number of memtable flush writer threads. These will be blocked by disk I/O, and each one will hold a memtable in memory while blocked. If you have a large Java heap size and many data directories (see data_file_directories), you can increase this value for better flush performance. By default this is set to the number of data directories defined (which is 1).
memtable_total_space_in_mb
Specifies total memory used for all column family memtables on a node. Defaults to a third of your JVM heap size. This replaces the old per-column family storage settings memtable_operations_in_millions and memtable_throughput_in_mb.
75
Configuration
multithreaded_compaction
When set to true (it is false by default), each compaction operation will use one thread per SSTable being merged in addition to one thread per core. This is typically only useful on nodes with SSD hardware. With regular disks, the goal is to limit the disk I/O for compaction (see compaction_throughput_mb_per_sec).
reduce_cache_capacity_to
Sets the size percentage to which maximum cache capacity is reduced when Java heap usage reaches the threshold defined by reduce_cache_sizes_at. Together with flush_largest_memtables_at, these properties are an emergency measure for preventing sudden out-of-memory (OOM) errors.
reduce_cache_sizes_at
When Java heap usage after a full concurrent mark sweep (CMS) garbage collection is higher than this percentage, Cassandra will reduce the cache capacity to the fraction of the current size as specified by reduce_cache_capacity_to. The default is 85 percent (0.85). 1.0 disables this feature.
sliced_buffer_size_in_kb
The buffer size (in kilobytes) to use for reading contiguous columns. This should match the size of the columns typically retrieved using query operations involving a slice predicate.
stream_throughput_outbound_megabits_per_sec
Throttles all outbound streaming file transfers on a node to the specified throughput in Mb per second. Cassandra does mostly sequential I/O when streaming data during bootstrap or repair, which can lead to saturating the network connection and degrading client performance. The default is 400 Mb/s or 50 MB/s.
request_scheduler
Defines a scheduler to handle incoming client requests according to a defined policy. This scheduler only applies to client requests, not inter-node communication. Useful for throttling client requests in implementations that have multiple keyspaces. Allowed Values are: org.apache.cassandra.scheduler.NoScheduler (default) org.apache.cassandra.scheduler.RoundRobinScheduler A Java class that implements the RequestScheduler interface If using the RoundRobinScheduler, there are additional request_scheduler_options properties.
request_scheduler_id
An identifier on which to perform request scheduling. Currently the only valid option is keyspace.
request_scheduler_options
Contains a list of additional properties that define configuration options for request_scheduler. NoScheduler does not have any options. RoundRobinScheduler has the following additional configuration properties: throttle_limit, default_weight, weights. throttle_limit
76
Configuration The number of active requests per client. Requests beyond this limit are queued up until running requests complete. The default is 80. Recommended value is ((concurrent_reads + concurrent_writes) * 2). default_weight The default weight controls how many requests are handled during each turn of the RoundRobin. The default is 1. weights Allows control of weight per keyspace during each turn of the RoundRobin. If not set, each keyspace uses the default_weight. Takes a list of list of keyspaces: weights.
rpc_keepalive
Enable or disable keepalive on client connections.
rpc_max_threads
Cassandra uses one thread-per-client for remote procedure calls. For a large number of client connections, this can cause excessive memory usage for the thread stack. Connection pooling on the client side is highly recommended. Setting a maximum thread pool size acts as a safeguard against misbehaved clients. If the maximum is reached, Cassandra will block additional connections until a client disconnects.
rpc_min_threads
Sets the minimum thread pool size for remote procedure calls.
rpc_recv_buff_size_in_bytes
Sets the receiving socket buffer size for remote procedure calls.
rpc_send_buff_size_in_bytes
Sets the sending socket buffer size in bytes for remote procedure calls.
rpc_timeout_in_ms
The time in milliseconds that a node will wait on a reply from other nodes before the command is failed.
rpc_server_type
Cassandra provides three options for the rpc server. The default is sync because hsha is about 30% slower on Windows. On Linux, sync and hsha performance is about the same with hsha using less memory. sync - (default) One connection per thread in the rpc pool. For a very large number of clients, memory will be your limiting factor; on a 64 bit JVM, 128KB is the minimum stack size per thread. Connection pooling is very, very strongly recommended. hsha Half synchronous, half asynchronous. The rpc thread pool is used to manage requests, but the threads are multiplexed across the different clients. async - Deprecated and will be removed in the next major release. Do not use.
thrift_framed_transport_size_in_mb
Specifies the frame size in megabytes (maximum field length) for Thrift. 0 disables framing. This option is deprecated in favor of thrift_max_message_length_in_mb.
77
Configuration
thrift_max_message_length_in_mb
The maximum length of a Thrift message in megabytes, including all fields and internal Thrift overhead.
dynamic_snitch_badness_threshold
Sets a performance threshold for dynamically routing requests away from a poorly performing node. A value of 0.2 means Cassandra would continue to prefer the static snitch values until the node response time was 20 percent worse than the best performing node. Until the threshold is reached, incoming client requests are statically routed to the closest replica (as determined by the configured snitch). Having requests consistently routed to a given replica can help keep a working set of data hot when read repair is less than 100% or disabled.
dynamic_snitch_reset_interval_in_ms
Time interval in milliseconds to reset all node scores (allowing a bad node to recover).
dynamic_snitch_update_interval_in_ms
The time interval in milliseconds for calculating read latency.
hinted_handoff_enabled
Enables or disables hinted handoff.
hinted_handoff_throttle_delay_in_ms
When a node detects that a node for which it is holding hints has recovered, it begins sending the hints to that node. This specifies a sleep interval (in milliseconds) after delivering each row or row fragment in an effort to throttle traffic to the recovered node.
max_hint_window_in_ms
Defines how long in milliseconds to generate and save hints for an unresponsive node. After this interval, hints are dropped. This can prevent a sudden demand for resources when a node is brought back online and the rest of the cluster attempts to replay a large volume of hinted writes. The default is one hour (3600000 ms).
phi_convict_threshold
The Phi convict threshold adjusts the sensitivity of the failure detector on an exponential scale . Lower values increase the likelihood that an unresponsive node will be marked as down, while higher values decrease the likelihood that transient failures will cause a node failure. In unstable network environments (such as EC2 at times), raising the value to 10 or 12 will prevent false failures. Values higher than 12 and lower than 5 are not recommended. The default is 8.
78
Configuration Backs up data updated since the last snapshot was taken. When enabled, each time an SSTable is flushed, a hard link is copied into a /backups subdirectory of the keyspace data directory.
snapshot_before_compaction
Defines whether or not to take a snapshot before each compaction. Be careful using this option, since Cassandra does not clean up older snapshots automatically. This can be useful to back up data when there is a data format change.
Security Properties
authenticator
The default value disables authentication. Basic authentication is provided using the SimpleAuthenticator, which uses the access.properties and password.properties configuration files to configure authentication privileges. Allowed values are: * org.apache.cassandra.auth.AllowAllAuthenticator * org.apache.cassandra.auth.SimpleAuthenticator * A Java class that implements the IAuthenticator interface
Note
The SimpleAuthenticator and SimpleAuthority classes have been moved to the example directory of the Apache Cassandra project repository as of release 1.0. They are no longer available in the packaged and binary distributions. They never provided actual security, and in their current state are only meant as examples.
authority
The default value disables user access control (all users can access all resources). To control read/write permissions to keyspaces and column families, use the SimpleAuthority, which uses the access.properties configuration file to define per-user access. Allowed values are: * org.apache.cassandra.auth.AllowAllAuthority * org.apache.cassandra.auth.SimpleAuthority * A Java class that implements the IAuthority interface
internode_encryption
Enables or disables encryption of inter-node communication using TLS_RSA_WITH_AES_128_CBC_SHA as the cipher suite for authentication, key exchange and encryption of the actual data transfers. To encrypt all inter-node communications, set to all. You must also generate keys and provide the appropriate key and trust store locations and passwords.
keystore
Description: The location of a Java keystore (JKS) suitable for use with Java Secure Socket Extension (JSSE), the Java version of the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols. The keystore contains the private key used to encrypt outgoing messages.
keystore_password
Password for the keystore.
truststore
The location of a truststore containing the trusted certificate used to authenticate remote servers.
truststore_password
Password for the truststore.
79
Configuration
Note
The attribute names documented in this section are the names as they are stored in the system keyspace within Cassandra. Most of these attributes can be set in the various client applications, such as Cassandra CLI or CQL. There may be slight differences in how these attributes are named depending on how they are implemented in the client.
Keyspace Attributes
A keyspace must have a user-defined name and a replica placement strategy. It also has replication strategy options, which is a container attribute for replication factor or the number of replicas per data center. Option ks_name placement_strategy strategy_options Default Value n/a (A user-defined value is required) org.apache.cassandra.locator.SimpleStrategy n/a (container attribute)
name
Required. The name for the keyspace.
placement_strategy
Required. Determines how replicas for a keyspace will be distributed among nodes in the ring. Allowed values are: org.apache.cassandra.locator.SimpleStrategy org.apache.cassandra.locator.NetworkTopologyStrategy org.apache.cassandra.locator.OldNetworkTopologyStrategy (deprecated) These options are described in detail in the replication section.
Note
NetworkTopologyStrategy and OldNetworkTopologyStrategy require a properly configured snitch to be able to determine rack and data center locations of a node (see endpoint_snitch).
strategy_options
Specifies configuration options for the chosen replication strategy. For SimpleStrategy, it specifies replication_factor:number_of_replicas. replication_factor in the format of
For NetworkTopologyStrategy, it specifies the number of replicas per data center in a comma separated list of datacenter_name:number_of_replicas. Note that what you specify for datacenter_name depends on the
80
Configuration cluster-configured snitch you are using. There is a correlation between the data center name defined in the keyspace strategy_options and the data center name as recognized by the snitch you are using. The nodetool ring command prints out data center names and rack locations of your nodes if you are not sure what they are. See Choosing Keyspace Replication Options for guidance on how to best configure replication strategy and strategy options for your cluster. Setting and updating strategy options with the Cassandra CLI requires a slightly different command syntax than other attributes; note the brackets and curly braces in this example: [default@unknown] CREATE KEYSPACE test WITH placement_strategy = 'NetworkTopologyStrategy' AND strategy_options=[{us-east:6,us-west:3}];
column_metadata
81
Configuration Column metadata defines attributes of a column. Values for name and validation_class are required, though the default_validation_class for the column family is used if no validation_class is specified. Note that index_type must be set to create a secondary index for a column. index_name is not valid unless index_type is also set. Name name validation_class index_name index_type Type used to check the column value. Name for the secondary index. Type of index. Currently the only supported value is KEYS. Description Binds a validation_class and (optionally) an index to a column.
Setting and updating column metadata with the Cassandra CLI requires a slightly different command syntax than other attributes; note the brackets and curly braces in this example:
[default@demo] UPDATE COLUMN FAMILY users WITH comparator=UTF8Type AND column_metadata=[{column_name: full_name, validation_class: UTF8Type, index_type: KEYS}];
column_type
Defaults to Standard for regular column families. For super column families, use Super.
comment
A human readable comment describing the column family.
compaction_strategy
Sets the compaction strategy for the column family. The available strategies are: SizeTieredCompactionStrategy - This is the default compaction strategy and the only compaction strategy available in pre-1.0 releases. This strategy triggers a minor compaction whenever there are a number of similar sized SSTables on disk (as configured by min_compaction_threshold). This strategy causes bursts in I/O activity while a compaction is in process, followed by longer and longer lulls in compaction activity as SSTable files grow larger in size. These I/O bursts can negatively effect read-heavy workloads, but typically do not impact write performance. Watching disk capacity is also important when using this strategy, as compactions can temporarily double the size of SSTables for a column family while a compaction is in progress. LeveledCompactionStrategy - The leveled compaction strategy limits the size of SSTables to a small file size (5 MB by default) so that SSTables do not continue to grow in size with each successive compaction. Disk I/O is more uniform and predictable as SSTables are continuously being compacted into progressively larger levels. At each level, row keys are merged into non-overlapping SSTables. This can improve performance for reads, because Cassandra can determine which SSTables in each level to check for the existence of row key data. This compaction strategy is modeled after Google's leveldb implementation.
compaction_strategy_options
Sets options related to the chosen compaction_strategy. Currently only LeveledCompactionStrategy has options. Option sstable_size_in_mb 5 Default Value Description Sets the file size for leveled SSTables. A compaction is triggered when unleveled SSTables (newly flushed SSTable files in Level 0) exceeds 4 * sstable_size_in_mb.
Setting and updating compaction strategy options with the Cassandra CLI requires a slightly different command syntax than other attributes; note the brackets and curly braces in this example:
82
Configuration
[default@demo] UPDATE COLUMN FAMILY users WITH compaction_strategy=LeveledCompactionStrategy AND compaction_strategy_options=[{sstable_size_in_mb: 10}];
comparator
Defines the data types used to validate and sort column names. There are several built-in column comparators available. Note that the comparator cannot be changed after a column family is created.
compare_subcolumns_with
Required when column_type is "Super". Same as comparator but for sub-columns of a SuperColumn. For attributes of columns, see column_metadata.
compression_options
This is a container attribute for setting compression options on a column family. It contains the following options: Option sstable_compression Description Specifies the compression algorithm to use when compressing SSTable files. Cassandra supports two built-in compression classes: SnappyCompressor (Snappy compression library) and DeflateCompressor (Java zip implementation). Snappy compression offers faster compression/decompression while the Java zip compression offers better compression ratios. Choosing the right one depends on your requirements for space savings over read performance. For read-heavy workloads, Snappy compression is recommended. Developers can also implement custom compression classes using the org.apache.cassandra.io.compress.ICompressor interface. Sets the compression chunk size in kilobytes. The default value (64) is a good middle-ground for compressing column families with either wide rows or with skinny rows. With wide rows, it allows reading a 64kb slice of column data without decompressing the entire row. For skinny rows, although you may still end up decompressing more data than requested, it is a good trade-off between maximizing the compression ratio and minimizing the overhead of decompressing more data than is needed to access a requested row.The compression chunk size can be adjusted to account for read/write access patterns (how much data is typically requested at once) and the average size of rows in the column family.
chunk_length_kb
Setting and updating compression options with the Cassandra CLI requires a slightly different command syntax than other attributes; note the brackets and curly braces in this example:
[default@demo] UPDATE COLUMN FAMILY users WITH compression_options=[{sstable_compression:SnappyCompressor, chunk_length_kb:64}];
default_validation_class
Defines the data type used to validate column values. There are several built-in column validators available.
gc_grace_seconds
Specifies the time to wait before garbage collecting tombstones (deletion markers). Defaults to 864000, or 10 days, which allows a great deal of time for consistency to be achieved prior to deletion. In many deployments this interval can be reduced, and in a single-node cluster it can be safely set to zero.
Note
This property is called gc_grace in the cassandra-cli client.
83
Configuration
key_cache_save_period_in_seconds
Sets number of seconds between saving key caches: the key caches can be saved periodically, and if one exists on startup it will be loaded.
Note
This property is called key_cache_save_period in the cassandra-cli client.
keys_cached
Defines how many key locations will be kept in memory per SSTable (see rows_cached for details on caching actual row values). This can be a fixed number of keys or a fraction (for example 0.5 means 50 percent). DataStax recommends a fixed sized cache over a relative sized cache. Only use relative cache sizing when you are confident that the data in the column family will not continue to grow over time. Otherwise, your cache will grow as your data set does, potentially causing unplanned memory pressure.
key_validation_class
Defines the data type used to validate row key values. There are several built-in key validators available, however CounterColumnType (distributed counters) cannot be used as a row key validator.
name
Required. The user-defined name of the column family.
read_repair_chance
Specifies the probability with which read repairs should be invoked on non-quorum reads. Must be between 0 and 1. Defaults to 0.1 (perform read repair 10% of the time). Lower values improve read throughput, but increase the chances of seeing stale values if you are not using a strong consistency level.
replicate_on_write
When set to true, replicates writes to all affected replicas regardless of the consistency level specified by the client for a write request. For counter column families, this should always be set to true.
max_compaction_threshold
Sets the maximum number of SSTables to allow in a minor compaction when compaction_strategy=SizeTieredCompactionStrategy. Obsolete as of Cassandra 0.8 with the addition of compaction throttling (see cassandra.yaml parameter compaction_throughput_mb_per_sec). Setting this to 0 disables minor compactions. Defaults to 32.
min_compaction_threshold
Sets the minimum number of SSTables to trigger a minor compaction when compaction_strategy=sizeTieredCompactionStrategy. Raising this value causes minor compactions to start less frequently and be more I/O-intensive. Setting this to 0 disables minor compactions. Defaults to 4.
memtable_flush_after_mins
Deprecated as of Cassandra 1.0. Can still be declared (for backwards compatibility) but settings will be ignored. Use the cassandra.yaml parameter commitlog_total_space_in_mb instead.
84
Configuration
memtable_operations_in_millions
Deprecated as of Cassandra 1.0. Can still be declared (for backwards compatibility) but settings will be ignored. Use the cassandra.yaml parameter commitlog_total_space_in_mb instead.
memtable_throughput_in_mb
Deprecated as of Cassandra 1.0. Can still be declared (for backwards compatibility) but settings will be ignored. Use the cassandra.yaml parameter commitlog_total_space_in_mb instead.
rows_cached
Specifies how many rows to cache in memory. This can be a fixed number of rows or a fraction (for example 0.5 means 50 percent). Using a row cache means that the entire row is cached in memory. This can be detrimental to performance in cases where rows are large, or where rows are frequently modified or removed.
row_cache_provider
Specifies the row cache to use for the column family. Allowed values are: * ConcurrentLinkedHashCacheProvider - Rows are cached using the JVM heap, providing the same row cache behavior as Cassandra versions prior to 0.8. * (default) SerializingCacheProvider - Cached rows are serialized and stored in memory off of the JVM heap, which can reduce garbage collection (GC) pressure on the JVM and thereby improve system performance. Serialized rows are also 8 to 12 times smaller than unserialized rows. This is the recommended setting, as long as you have jna.jar in the CLASSPATH to enable native methods.
row_cache_save_period_in_seconds
Sets the number of seconds between saving row caches: the row caches can be saved periodically, and if one exists on startup it will be loaded.
JMX Options
Cassandra exposes a number of statistics and management operations via Java Management Extensions (JMX). Java Management Extensions (JMX) is a Java technology that supplies tools for managing and monitoring Java applications and services. Any statistic or operation that a Java application has exposed as an MBean can then be monitored or manipulated using JMX. JConsole, nodetool and DataStax OpsCenter are examples of JMX-compliant management
85
Configuration tools. By default, the conf/cassandra-env.sh file configures JMX to listen on port 7199 without authentication. See the table below for more information on commonly changed JMX configuration properties. com.sun.management.jmxremote.port - The port on which Cassandra listens from JMX connections com.sun.management.jmxremote.ssl - Enable/disable SSL for JMX com.sun.management.jmxremote.authenticate - Enable/disable remote authentication for JMX -Djava.rmi.server.hostname - Sets the interface hostname or IP that JMX should use to connect. Uncomment and set if you are having trouble connecting.
access.properties
This file contains entries in the format KEYSPACE[.COLUMNFAMILY].PERMISSION=USERS where KEYSPACE is the keyspace name. COLUMNFAMILY is the column family name. PERMISSION is one of <ro> or <rw> for read-only or read-write respectively. USERS is a comma delimited list of users from passwd.properties.
86
Configuration For example, to control access to Keyspace1 and give jsmith and Elvis read-only permissions while allowing dilbert full read-write access to add and remove column families, you would create the following entries: Keyspace1.<ro>=jsmith,Elvis Presley Keyspace1.<rw>=dilbert To provide a finer level of access control to the Standard1 column family in Keyspace1, you would create the following entry to allow the specified users read-write access: Keyspace1.Standard1.<rw>=jsmith,Elvis Presley,dilbert The access.properties file also contains a simple list of users who have permissions to modify the list of keyspaces: <modify-keyspaces>=jsmith
passwd.properties
This file contains name/value pairs in which the names match users defined in access.properties and the values are user passwords. Passwords are in clear text unless the passwd.mode=MD5 system property is provided. jsmith=havebadpass Elvis Presley=graceland4ever dilbert=nomoovertime
Logging Configuration
In some situations, the output provided by Cassandra's JMX MBeans and the nodetool utility are not enough to diagnose issues. If you find yourself in a place where you need more information about the runtime behavior of a specific Cassandra node, you can increase the logging levels to get more diagnostic information on specific portions of the system. Cassandra uses a SLF4J to provide logging functionality; by default a log4j backend is used. Many of the core Cassandra classes have varying levels of logging output available which can be increased in one of two ways: 1. Updating the log4j-server.properties file 2. Through JMX
87
Operations To change logging levels via JMX, bring up the JConsole tool and attach it to the CassandraDaemon process. Locate the StorageService MBean and find setLog4jLevel under the Operations list. This operation takes two arguments - a class qualifier and a logging level. The class qualifier can either be a full class name or any portion of a package name, similar to the log4j-server.properties configuration above except without the initial log4j.logger appender assignment. The level must be one of the standard logging levels in use by Log4j. In keeping with our initial example, to adjust the logging output of StorageProxy to DEBUG, the first argument would be org.apache.cassandra.service.StorageProxy, and the second one DEBUG. On a system with traffic, you should see the effects of this change immediately.
Operations
Monitoring a Cassandra Cluster
Understanding the performance characteristics of your Cassandra cluster is critical to diagnosing issues and planning capacity. Cassandra exposes a number of statistics and management operations via Java Management Extensions (JMX). Java Management Extensions (JMX) is a Java technology that supplies tools for managing and monitoring Java applications and services. Any statistic or operation that a Java application has exposed as an MBean can then be monitored or manipulated using JMX. During normal operation, Cassandra outputs information and statistics that you can monitor using JMX-compliant tools such as JConsole, the Cassandra nodetool utility, or the DataStax OpsCenter management console. With the same tools, you can perform certain administrative commands and operations such as flushing caches or doing a repair.
88
Operations
The performance metrics viewed within OpsCenter can be customized according to your monitoring needs. Administrators can also perform routine node administration tasks from OpsCenter. Metrics within OpsCenter are divided into three general categories: column family metrics, cluster metrics, and OS metrics. For many of the available metrics, you can choose to view aggregated cluster-wide information, or view information on a per-node basis.
89
Operations
10.196.14.48 10.196.14.239
Up Up
Normal Normal
3.16 KB 3.16 KB
30.01 30.01
78197033789183047700859117509977881938 95315431979199388464207182617231204396
| | |-->|
The nodetool utility provides commands for viewing detailed metrics for column family metrics, server metrics, and compaction statistics. Commands are also available for important operations such as decommissioning a node, running repair, and moving partitioning tokens.
90
Operations
If you choose to monitor Cassandra using JConsole, keep in mind that JConsole consumes a significant amount of system resources. For this reason, DataStax recommends running JConsole on a remote machine rather than on the same host as a Cassandra node.
Compaction Metrics
Monitoring compaction performance is an important aspect of knowing when to add capacity to your cluster. The following attributes are exposed through CompactionManagerMBean: Attribute CompletedTasks PendingTasks ColumnFamilyInProgress BytesTotalInProgress Description Number of completed compactions since the last start of this Cassandra instance Number of estimated tasks remaining to perform ColumnFamily currently being compacted. null if no compactions are in progress. Total number of data bytes (index and filter are not included) being compacted. null if no compactions are in progress.
91
Operations
BytesCompacted
CONSISTENCY-MANAGER Handles the background consistency checks if they were triggered from the client's consistency level <consistency> FLUSH-SORTER-POOL FLUSH-WRITER-POOL GOSSIP_STAGE LB-OPERATIONS LB-TARGET Sorts flushes that have been submitted Writes the sorted flushes Activity of the Gossip protocol on the ring The number of load balancing operations Used by nodes leaving the ring
MEMTABLE-POST-FLUSHER Memtable flushes that are waiting to be written to the commit log. MESSAGE-STREAMING-POOL Streaming operations. Usually triggered by bootstrapping or decommissioning nodes. MIGRATION_STAGE MISC_STAGE MUTATION_STAGE READ_STAGE RESPONSE_STAGE STREAM_STAGE API calls that are modifying data API calls that have read data Response tasks from other nodes to message streaming from this node Stream tasks from this node Tasks resulting from the call of system_* methods in the API that have modified the schema
ColumnFamily Statistics
For individual column families, ColumnFamilyStoreMBean provides the same general latency attributes as StorageProxyMBean. Unlike StorageProxyMBean, ColumnFamilyStoreMBean has a number of other statistics that are important to monitor for performance trends. The most important of these are listed below: Attribute MemtableDataSize MemtableColumnsCount MemtableSwitchCount Description The total size consumed by this column family's data (not including meta data) Returns the total number of columns present in the memtable (across all keys) How many times the memtable has been flushed out
RecentReadLatencyMicros The average read latency since the last call to this bean RecentWriterLatencyMicros The average write latency since the last call to this bean
92
Operations
LiveSSTableCount
The first three Memtable attributes are discussed in detail on the Tuning Cassandra page. The recent read latency and write latency counters are important in making sure that operations are happening in a consistent manner. If these counters start to increase after a period of staying flat, it is probably an indication of a need to add cluster capacity. LiveSSTableCount can be monitored with a threshold to ensure that the number of SSTables for a given ColumnFamily does not become too great.
Monitor new cache settings not only for hit rate, but also to make sure that memtables and heap size still have sufficient memory for other operations. If you cannot maintain the desired key cache hit rate of 85% or better, add nodes to the system and re-test until you can meet your caching requirements. Row cache is disabled by default. Caching large rows can very quickly consume memory. Row cache rates should be increased carefully in small increments. If row cache hit rates cannot be tuned to above 30%, it may make more sense to leave row caching disabled.
Tuning Cassandra
Effective tuning depends not only on the types of operations your cluster performs most frequently, but also on the shape of the data itself. For example, Cassandra's memtables have overhead for index structures on top of the actual data they store. If the size of the values stored in the columns is small compared to the number of columns and rows themselves (sometimes called skinny rows), this overhead can be substantial. Thus, the optimal tuning for this type of data is quite different than the optimal tuning for a small numbers of columns with more data (fat rows).
93
Operations
94
Operations Row cache performance can be monitored by using nodetool cfstats and examining the reported 'Row cache hit rate'. See also Monitoring and Adjusting Cache Performance for more information about monitoring tuning changes to a column family key cache.
95
Operations
Note
As of Cassandra 1.0, column family row caches are stored in native memory by default (outside of the Java heap). This results in both a smaller per-row memory footprint and reduced JVM heap requirements, which helps keep the heap size manageable for good JVM garbage collection performance.
Tuning Compaction
During normal operations, numerous SSTables may be created on disk for a given column family. Compaction is the process of merging multiple SSTables into one consolidated SSTable. Additionally, the compaction process merges keys, combines columns, discards tombstones and creates a new index in the merged SSTable.
96
Operations
[default@demo] UPDATE COLUMN FAMILY users WITH compaction_strategy=LeveledCompactionStrategy AND compaction_strategy_options=[{sstable_size_in_mb: 10}];
Note
Administrators can also initiate a major compaction through nodetool compact, which merges all SSTables into one. Though major compaction can free disk space used by accumulated SSTables, during runtime it temporarily doubles disk space usage and is I/O and CPU intensive. Also, once you run a major compaction, automatic minor compactions are no longer triggered frequently forcing you to manually run major compactions on a routine basis. So while read performance will be good immediately following a major compaction, it will continually degrade until the next major compaction is manually invoked. For this reason, major compaction is NOT recommended by DataStax.
Note
Repair is an expensive operation in both disk and CPU consumption. Use caution when running node repair on more than one node at a time, and schedule regular repair operations for low-usage hours. In systems that seldom delete or overwrite data, it is possible to raise the value of gc_grace_seconds at a minimal cost in extra disk space used. This allows wider intervals for scheduling repair operations with the nodetool utility.
97
Operations
Its position in the ring and the range of data it is responsible for. This is determined by the settings of initial_token and auto_bootstrap when the node first starts up. The nodes it should contact to learn about the cluster and establish the gossip process. This is determined by the setting of seeds when the node first starts up. The name of the cluster it is joining and how the node should be addressed within the cluster. See Node and Cluster Initialization Properties in cassandra.yaml. Any other non-default adjustments made to cassandra.yaml on your existing cluster should also be made on the new node as well before it is started.
98
Operations
Note
DataStax Enterprise customers can use DataStax OpsCenter Enterprise Edition to automatically rebalance their cluster after adding new nodes. OpsCenter's rebalance feature will automatically calculate balanced token ranges and perform steps 5 and 6 on each node in the cluster in the correct order.
2. Prepare the replacement node by installing Cassandra and correctly configuring its cassandra.yaml file. 3. Start Cassandra on the new node using the startup property -Dcassandra.replace_token=<token> and pass in the same token that was used by the dead node. For example: $ cassandra -Dcassandra.replace_token=28356863910078205288614550619314017621
99
Operations
4. The new node will start in a hibernate state and begin to bootstrap data from its associated replica nodes. During this time, the node will not accept writes and is seen as down to other nodes in the cluster. When the bootstrap is complete, the node will be marked as up and any missed writes that occurred during bootstrap will be replayed using hinted handoff. 5. Once the new node is up, it is strongly recommended to run nodetool repair on each keyspace to ensure the node is fully consistent. For example: $ nodetool repair -h 10.46.123.12 keyspace_name -pr
Taking a Snapshot
Snapshots are taken per node using the :ref:` nodetool snapshot <nodetool-snapshot>` command. If you want to take a global snapshot (capture all nodes in the cluster at the same time), run the nodetool snapshot command using a parallel ssh utility, such as pssh. The snapshot command first flushes all in-memory writes to disk, then makes a copy of all on-disk data files (SSTable files) for each keyspace. The snapshot files are created in the Cassandra data directory location (/var/lib/cassandra/data by default) in the snapshots directory of each keyspace. You must have enough disk space on the node in order to accommodate making a full copy of your data files. After the snapshot is complete, you can move the backup files off to another location if needed, or you can leave them in place. To create a snapshot of a node Run the nodetool snapshot command, specifying the hostname, JMX port and snapshot name. For example: $ nodetool -h localhost -p 7199 snapshot 12022011 The snapshot will be created <data_directory_location>/<keyspace_name>/snapshots/<snapshot_name>. Each contains numerous .db files which contain the data at the time of the snapshot. snapshot in folder
100
References
Note
Restoring from snapshots and incremental backups will temporarily cause intensive CPU and I/O activity on the node being restored. To restore a node from a snapshot and incremental backups: 1. Shut down the node to be restored. 2. Clear all files under the commitlog directory, (in /var/lib/cassandra/commitlog by default). 3. Clear all *.db files under $DATA_DIRECTORY/<keyspace_name>, but DO NOT delete the /snapshots and /backups subdirectories. 4. Locate the most recent snapshot $DATA_DIRECTORY/<keyspace_name>/snapshots/<snapshot_name>, and $DATA_DIRECTORY/<keyspace_name>. folder copy its contents under into
5. If using incremental backups as well, copy all contents of $DATA_DIRECTORY/<keyspace_name>/backups into $DATA_DIRECTORY/<keyspace_name>. 6. Restart the node, keeping in mind that a temporary burst of I/O activity will consume a large amount of CPU resources.
References
CQL Language Reference
Cassandra Query Language (CQL) is based on SQL (Structured Query Language), the standard for relational database manipulation. Although CQL has many similarities to SQL, there are some fundamental differences. For example, it is adapted to the Cassandra data model and architecture so there is still no allowance for SQL-like operations such as JOINs or range queries over rows on clusters that use the random partitioner.
101
References A token can be a keyword, an identifier, a constant (or literal) value, or a special character symbol. Tokens are normally separated by whitespace (space, tab, newline). For example, the following is (syntactically) valid CQL input:
SELECT * FROM MyColumnFamily; UPDATE MyColumnFamily SET 'SomeColumn' = 'SomeValue' WHERE KEY = B70DE1D0-9908-4AE3-BE34-5573E5B09F14;
This is a sequence of two CQL statements. This example shows one statement per line, although a statement can usefully be split across lines as well.
CQL Constants
A constant, also known as a literal or a scalar value, represents a specific data value. The format of a constant depends on the data type of the value it represents. There are four types of implicitly-typed constants in CQL: string values, integer and float numeric values, and universally unique identifier (UUID) values. Constants can also be explicitly typed. string - A string constant is an arbitrary sequence of characters bounded by single quotes ('). To include a single-quote character within a string constant, use two adjacent single quotes (for example, 'Joe''s Diner'). Note that this is not the same as a double-quote character ("). integer - An integer constant is one or more digits (0 through 9) preceded by an optional minus sign (-). Note that there is no optional plus sign (+). There is also no provision for exponential notation such as 5e2. float - A float constant is specified as <digits>.<digits>, where <digits> is one or more digits ((0 through 9). Note that there must be digits both before and after the decimal point (for example 0.12 instead of .12). There is also no provision for exponential notation such as 1.925e-3. uuid - A universally unique identifier can be expressed in the canonical UUID form: 32 hex digits (0-9 or a-f, case insensitive), separated by dashes (-) after the 8th, 12th, 16th, and 20th digits. For example: 01234567-0123-0123-0123-0123456789ab
CQL Comments
Comments can be used to document CQL statements in your application code. Single line comments can begin with a double dash (--) or a double slash (//) and extend to the end of the line. Multi-line comments can be enclosed in /* and */ characters.
102
References
SELECT * FROM users WHERE state='TX' USING CONSISTENCY QUORUM; The following consistency levels can be specified. See tunable consistency for more information about the different consistency levels. ANY (applicable to writes only) ONE QUORUM LOCAL_QUOROM (applicable to multi-data center clusters only) EACH_QUOROM (applicable to multi-data center clusters only)
103
References The +0000 is the RFC 822 4-digit time zone specification for GMT. US Pacific Standard Time is -0800. The time zone may be omitted. For example: 2011-02-03 04:05 2011-02-03 04:05:00 2011-02-03T04:05 2011-02-03T04:05:00 If no time zone is specified, the time zone of the Cassandra coordinator node handing the write request will be used. For accuracy, DataStax recommends specifying the time zone rather than relying on the time zone configured on the Cassandra nodes. If you only want to capture date values, the time of day can also be omitted. For example: 2011-02-03 2011-02-03+0000 In this case, the time of day will default to 00:00:00, in the specified or default time zone.
104
References
key_cache_save_period_in_seconds replicate_on_write
14400 false
CQL Commands
The CQL language is comprised on the following commands:
ALTER COLUMNFAMILY
Manipulates the column metadata of a column family. Synopsis ALTER COLUMNFAMILY <name> ALTER <column_name> TYPE <data_type> | ADD <column_name> <data_type> | DROP <column_name> ; Description ALTER COLUMNFAMILY is used to manipulate the column metadata of a static column family. You can also use the alias ALTER TABLE. Using the alias, you can add new columns, drop existing columns, or change the data storage type of existing columns. No results are returned. See CQL Data Types for the available data types. Parameters <name> The name of the column family to be altered. ALTER <column_name> TYPE <data_type> Changes the data type of an existing column. The named column must exist in the column family schema definition and have a type defined, but the column does not have to exist in any rows currently stored in the column family. Note that when you change the data type of a column, existing data is not changed or validated on disk. If existing data is not compatible with the defined type, then this will cause your CQL driver or other client interfaces to return errors when accessing the data. For example if you changed a column type to int, but the existing stored data had non-numeric characters in it, your client requests of that data would report errors. ADD <column_name> <data_type> Adds a typed column to the column metadata of a column family schema definition. The column must not already have a type in the column family metadata. DROP <column_name> <data_type> Removes a column from the column family metadata. Note that this does not remove the column from current rows. It just removes the metadata saying that the values stored under that column name are expected to be a certain type. Examples ALTER COLUMNFAMILY users ALTER email TYPE varchar; ALTER COLUMNFAMILY users ADD gender varchar; ALTER COLUMNFAMILY users DROP gender;
105
References
BATCH
Sets a global consistency level, client-supplied timestamp, and optional time-to-live (TTL) for all columns written by the statements in the batch. Synopsis BEGIN BATCH [ USING <write_option> [ AND <write_option> [...] ] ]; <dml_statement> <dml_statement> [...] APPLY BATCH; where <write_option> is: USING CONSISTENCY <consistency_level> TTL <seconds> TIMESTAMP <integer> Description A BATCH statement allows you combine multiple data modification statements into a single logical operation. All columns modified by the batch statement will have the same global timestamp. Only INSERT, UPDATE, and DELETE statements are allowed within a BATCH statement. Individual statements within a BATCH should be specified one statement per line without an ending semi-colon. All statements within the batch are executed using the same consistency level. BATCH should not be considered as an analogue for SQL ACID transactions. BATCH does not provide transaction isolation. Column updates are only considered atomic within a given record (row). Parameters BEGIN BATCH Command to initiate a batch. All statements in the batch will be executed with the same timestamp and consistency level (and optional time-to-live). USING CONSISTENCY <consistency_level> Optional clause to specify the consistency level. If omitted, the default consistency level is ONE. The following consistency levels can be specified. See tunable consistency for more information about the different consistency levels. ANY (applicable to writes only) ONE QUORUM LOCAL_QUOROM (applicable to multi-data center clusters only) EACH_QUOROM (applicable to multi-data center clusters only) TTL <seconds> Optional clause to specify a time-to-live (TTL) period for an inserted or updated column. TTL columns are automatically marked as deleted (with a tombstone) after the requested amount of time has expired. TIMESTAMP <integer>
106
References Defines an optional timestamp to use for the written columns. The timestamp must be in the form of an integer. <dml_statement> An INSERT, UPDATE, or DELETE statement to be executed. A statement should be contained on a single line and without an ending semi-colon. APPLY BATCH Closes the batch statement. All statements in the batch are submitted for execution as a unit. Example BEGIN BATCH USING CONSISTENCY QUORUM AND TTL 8640000 INSERT INTO users (KEY, password, name) VALUES ('user2', 'ch@ngem3b', 'second user') UPDATE users SET password = 'ps22dhds' WHERE KEY = 'user2' INSERT INTO users (KEY, password) VALUES ('user3', 'ch@ngem3c') DELETE name FROM users WHERE key = 'user2' INSERT INTO users (KEY, password, name) VALUES ('user4', 'ch@ngem3c', 'Andrew') APPLY BATCH;
CREATE COLUMNFAMILY
Define a new column family. Synopsis CREATE COLUMNFAMILY <cf_name> ( <key_column_name> <data_type> PRIMARY KEY [, <column_name> <data_type> [, ...] ] ) [ WITH <storage_parameter> = <value> [AND <storage_parameter> = <value> [...] ] ]; Description CREATE COLUMNFAMILY creates a new column family under the current keyspace. You can also use the alias CREATE TABLE. The only schema information that must be defined for a column family is the primary key (or row key) and its associated data type. Other column metadata can be defined as needed. See CQL Data Types for the available data types. See CQL Column Family Storage Parameters for the available storage parameters you can define on a column family when using CQL. Parameters <cf_name> Defines the name of the column family. Valid column family names are strings of alpha-numeric characters and underscores, and must begin with a letter. <key_column_name> <data_type> PRIMARY KEY Columns are defined in a comma-separated list enclosed in parenthesis. The first column listed in the column definition is always the row key (or primary key of the column family), and is required. Any other column definitions are optional. Row keys can be defined using the generic KEY keyword, or can be given a column name to use as the alias for the row key. The row key data type must be compatible with the partitioner configured for your Cassandra cluster. For example, OrderPreservingPartitioner requires UTF-8 row keys. 107
References <column_name> <data_type> Defines column metadata for static column families (when you know what the column names will be ahead of time). WITH <storage_parameter> = <value> Defines certain storage parameters on a column family. See CQL Column Family Storage Parameters for the available storage parameters you can define on a column family when using CQL. For dynamic column families (where you do not know the column names ahead of time), it is best practice to still define a default data type for column names ( using WITH comparator=<data_type>) and values (using WITH default_validation=<data_type>). Examples Dynamic column family definition: CREATE COLUMNFAMILY user_events (user text PRIMARY KEY) WITH comparator=timestamp AND default_validation=int; Static column family definition: CREATE COLUMNFAMILY users ( KEY uuid PRIMARY KEY, username text, email text ) WITH comment='user information' AND read_repair_chance = 1.0;
CREATE INDEX
Define a new secondary index on a single, typed column of a column family. Synopsis CREATE INDEX [<index_name>] ON <cf_name> (<column_name>); Description CREATE INDEX creates a secondary index on the named column family, for the named column. A secondary index can only be created on a single, typed column. The indexed column must have a data type defined in the column metadata of the column family definition, although it is not required that the column exist in any currently stored rows. Parameters <index_name> Optionally defines a name for the secondary index. Valid index names are strings of alpha-numeric characters and underscores, and must begin with a letter. ON <cf_name> (<column_name>) Specifies the column family and column name on which to create the secondary index. The named column must have a data type defined in the column family schema definition. Examples Define a static column family and then create a secondary index on two of its named columns:
108
References
CREATE COLUMNFAMILY users ( KEY uuid PRIMARY KEY, firstname text, lastname text, email text, address text, zip int, state text); CREATE INDEX user_state ON users (state); CREATE INDEX ON users (zip);
CREATE KEYSPACE
Define a new keyspace and its replica placement strategy. Synopsis CREATE KEYSPACE <ks_name> WITH strategy_class = <value> [ AND strategy_options:<option> = <value> [...] ]; Description CREATE KEYSPACE creates a new keyspace and sets the replica placement strategy (and associated replication options) for the keyspace. See Choosing Keyspace Replication Options for guidance on how to best configure replication strategy and strategy options for your cluster. Parameters <ks_name> Defines the name of the keyspace. Valid keyspace names are strings of alpha-numeric characters and underscores, and must begin with a letter. WITH strategy_class=<value> Required. Sets the replica placement strategy to use for this keyspace. The most common choices are NetworkTopologyStrategy or SimpleStrategy. AND strategy_options:<option>=<value> Certain additional options must be defined depending on the replication strategy chosen. For SimpleStrategy, you must specify the strategy_options:replication_factor=<number>. replication factor in the format of
For NetworkTopologyStrategy, you must specify the number of replicas per data center in the format of strategy_options:<datacenter_name>=<number>. Note that what you specify for <datacenter_name> depends on the cluster-configured snitch you are using. There is a correlation between the data center name defined in the keyspace strategy_options and the data center name as recognized by the snitch you are using. The nodetool ring command prints out data center names and rack locations of your nodes if you are not sure what they are. Examples
109
References Define a new keyspace using the simple replication strategy: CREATE KEYSPACE MyKeyspace WITH strategy_class = 'SimpleStrategy' AND strategy_options:replication_factor = 1; Define a new keyspace using a network-aware replication strategy and snitch. This example assumes you are using the PropertyFileSnitch and your data centers are named DC1 and DC2 in the cassandra-topology.properties file: CREATE KEYSPACE MyKeyspace WITH strategy_class = 'NetworkTopologyStrategy' AND strategy_options:DC1 = 3 AND strategy_options:DC2 = 3;
DELETE
Removes one or more columns from the named row(s). Synopsis DELETE [<column_name> [, ...]] FROM <column_family> [USING CONSISTENCY <consistency_level> [AND TIMESTAMP <integer>]] WHERE <row_specification>; where <row_specification> is: KEY | <key_alias> = <key_value> KEY | <key_alias> IN (<key_value> [,...]) Description A DELETE statement removes one or more columns from one or more rows in the named column family. Rows are identified using the KEY keyword or the key alias defined on the column family. If no column names are given, the entire row is deleted. When a column is deleted, it is not removed from disk immediately. The deleted column is marked with a tombstone and then removed after the configured grace period has expired. See About Deletes for more information about how Cassandra handles deleted columns and rows. Parameters <column_name> The name of one or more columns to be deleted. If no column names are given, then all columns in the identified rows will be deleted, essentially deleting the entire row. FROM <column_family> The name of the column family from which to delete the identified columns or rows. USING CONSISTENCY <consistency_level> Optional clause to specify the consistency level. If omitted, the default consistency level is ONE. The following consistency levels can be specified. See tunable consistency for more information about the different consistency levels. ANY (applicable to writes only) ONE QUORUM LOCAL_QUOROM (applicable to multi-data center clusters only) EACH_QUOROM (applicable to multi-data center clusters only)
110
References TIMESTAMP <integer> Defines an optional timestamp to use for the new tombstone record. The timestamp must be in the form of an integer. WHERE <row_specification> The WHERE clause identifies one or more rows in the column family from which to delete columns. Rows are identified using the KEY keyword or the key alias defined on the column family, and then supplying one or more row key values. Example DELETE email, phone FROM users USING CONSISTENCY QUORUM AND TIMESTAMP 1318452291034 WHERE user_name = 'jsmith'; DELETE FROM users WHERE KEY IN ('dhutchinson', 'jsmith');
DROP COLUMNFAMILY
Drops the named column family. Synopsis DROP COLUMNFAMILY <name>; Description A DROP COLUMNFAMILY statement results in the immediate, irreversible removal of a column family, including all data contained in the column family. You can also use the alias DROP TABLE. Parameters <name> The name of the column family to be dropped. Example DROP COLUMNFAMILY users;
DROP INDEX
Drops the named secondary. Synopsis DROP INDEX <name>; Description A DROP INDEX statement removes an existing secondary index. Parameters <name>
111
References The name of the secondary index to be dropped. If the index was not given a name during creation, the index name is <columnfamily_name>_<column_name>_idx. Example DROP INDEX user_state; DROP INDEX users_zip_idx;
DROP KEYSPACE
Drops the named keyspace. Synopsis DROP KEYSPACE <name>; Description A DROP KEYSPACE statement results in the immediate, irreversible removal of a keyspace, including all column families and data contained in the keyspace. Parameters <name> The name of the keyspace to be dropped. Example DROP KEYSPACE Demo;
INSERT
Inserts or updates one or more columns in the identified row of a column family. Synopsis INSERT INTO <column_family> (<key_name>, <column_name> [, ...]) VALUES (<key_value>, <column_value> [, ...]) [USING <write_option> [AND <write_option> [...] ] ]; where <write_option> is: USING CONSISTENCY <consistency_level> TTL <seconds> TIMESTAMP <integer> Description An INSERT is used to write one or more columns to the identified row in a Cassandra column family. No results are returned. Unlike in SQL, the semantics of INSERT and UPDATE are identical. In either case a row/column record is created if does not exist, or updated if it does exist. The first column name in the INSERT list must be that of the row key (either the KEY keyword or the row key alias defined on the column family). The first column value in the VALUES list is the row key value for which you want to insert or update columns. After the row key, there must be at least one other column name specified. In Cassandra, a
112
References row with only a key and no associated columns is not considered to exist. Parameters <column_family> (<key_name>, <column_name> [, ...]) The name of the column family to insert or update followed by a comma-separated list of column names enclosed in parenthesis. The first name in the list must be that of the row key (either the KEY keyword or the row key alias defined on the column family) followed by at least one other column name. VALUES (<key_value>, <column_value> [, ...]) Supplies a comma-separated list of column values enclosed in parenthesis. The first column value is always the row key value for which you want to insert columns. Column values should be listed in the same order as the column names supplied in the INSERT list. If a row or column does not exist, it will be inserted. If it does exist, it will be updated. USING CONSISTENCY <consistency_level> Optional clause to specify the consistency level. If omitted, the default consistency level is ONE. The following consistency levels can be specified. See tunable consistency for more information about the different consistency levels. ANY (applicable to writes only) ONE QUORUM LOCAL_QUOROM (applicable to multi-data center clusters only) EACH_QUOROM (applicable to multi-data center clusters only) TTL <seconds> Optional clause to specify a time-to-live (TTL) period for an inserted or updated column. TTL columns are automatically marked as deleted (with a tombstone) after the requested amount of time has expired. TIMESTAMP <integer> Defines an optional timestamp to use for the written columns. The timestamp must be in the form of an integer. Example INSERT INTO users (KEY, user_name) VALUES ('cfd66ccc-d857-4e90-b1e5-df98a3d40cd6', 'jbellis') USING CONSISTENCY LOCAL_QUORUM AND TTL 86400;
SELECT
Returns the requested rows and columns from a Cassandra column family. Synopsis SELECT <column_specification> FROM [<keyspace>.]<column_family> [USING CONSISTENCY <consistency_level>] [WHERE <row_specification> [AND <row_specification> [...]] [LIMIT <integer>] where <column_specification> is:
113
References
<column_name> [, ...] | [FIRST <integer>] [REVERSED] { <start_of_range> .. <end_of_range> | * } | COUNT(*) and where <row_specification> is: KEY | <key_alias> { = | < | > | <= | >= } <key_value> KEY | <key_alias> IN (<key_value> [,...]) Description A SELECT is used to read one or more rows from a Cassandra column family. It returns a result-set of rows, where each row consists of a row key and a collection of columns corresponding to the query. Unlike a SQL SELECT, there is no guarantee that the columns specified in the query will be contained in the result set. Cassandra has a schema-optional data model, so it will not give an error if you request columns that do not exist. Parameters The SELECT List The SELECT list determines the columns that will appear in the results. It takes a comma-separated list of column names, a range of column names, or COUNT(*). Column names in Cassandra can be specified as string literals or integers, in addition to named identifiers. To specify a range of columns, specify the start and end column names separated by two periods (..). The set of columns returned for a range is start and end inclusive. The asterisk (*) may also be used as a range representing all columns. When requesting a range of columns, it may be useful to limit the number of columns that can be returned from each row using the FIRST clause. This sets an upper limit on the number of columns returned per row (the default is 10,000 if not specified). The REVERSED keyword causes the columns to be returned in reversed sorted order. If using a FIRST clause, the columns at the end of the range will be selected instead of the ones at the beginning of the range. A SELECT list may also be COUNT(*). In this case, the result will be the number of rows which matched the query. The FROM Clause The FROM clause specifies the column family to query. If a keyspace is not specified, the current keyspace will be used. USING CONSISTENCY <consistency_level> Optional clause to specify the consistency level. If omitted, the default consistency level is ONE. The following consistency levels can be specified. See tunable consistency for more information about the different consistency levels. ONE QUORUM LOCAL_QUOROM (applicable to multi-data center clusters only) EACH_QUOROM (applicable to multi-data center clusters only) The WHERE Clause
114
References The WHERE clause filters the rows that appear in the results. You can filter on a key name, a range of keys, or on column values (in the case of columns that have a secondary index). Row keys are specified using the KEY keyword or key alias defined on the column family, followed by a relational operator (one of =, >, >=, <, or <=), and then a value. When terms appear on both sides of a relational operator it is assumed the filter applies to an indexed column. With column index filters, the term on the left of the operator must be the name of the indexed column, and the term on the right is the value to filter on. Note: The greater-than and less-than operators (> and <) result in key ranges that are inclusive of the terms. There is no supported notion of strictly greater-than or less-than; these operators are merely supported as aliases to >= and <=. The LIMIT Clause The LIMIT clause limits the number of rows returned by the query. The default is 10,000 rows. Examples Select two columns from three rows: SELECT name, title FROM employees WHERE KEY IN (199, 200, 207); Select a range of columns from all rows, but limit the number of columns to 3 per row starting with the end of the range: SELECT FIRST 3 REVERSED 'time199'..'time100' FROM events; Count the number of rows in a column family: SELECT COUNT(*) FROM users;
TRUNCATE
Removes all data from a column family. Synopsis TRUNCATE <column_family>; Description A TRUNCATE statement results in the immediate, irreversible removal of all data in the named column family. Parameters <column_family> The name of the column family to truncate. Example TRUNCATE user_activity;
UPDATE
Updates one or more columns in the identified row of a column family. Synopsis UPDATE <column_family> [ USING <write_option> [ AND <write_option> [...] ] ];
115
References
SET <column_name> = <column_value> [, ...] | <counter_column_name> = <counter_column_name> {+ | -} <integer> WHERE <row_specification>; where <write_option> is: USING CONSISTENCY <consistency_level> TTL <seconds> TIMESTAMP <integer> and where <row_specification> is: KEY | <key_alias> = <key_value> KEY | <key_alias> IN (<key_value> [,...]) Description An UPDATE is used to update or write one or more columns to the identified row in a Cassandra column family. Row/column records are created if they do not exist, or updated if they do exist. Rows are created or updated by supplying column names and values, after the SET keyword. Multiple columns can be set by separating the name/value pairs using commas. Each update statement requires a precise set of row keys to be specified using a WHERE clause. Rows are identified using the KEY keyword or the key alias defined on the column family. Parameters <column_family> The name of the column family from which to update (or insert) the identified columns and rows. USING CONSISTENCY <consistency_level> Optional clause to specify the consistency level. If omitted, the default consistency level is ONE. The following consistency levels can be specified. See tunable consistency for more information about the different consistency levels. ANY (applicable to writes only) ONE QUORUM LOCAL_QUOROM (applicable to multi-data center clusters only) EACH_QUOROM (applicable to multi-data center clusters only) TTL <seconds> Optional clause to specify a time-to-live (TTL) period for an inserted or updated column. TTL columns are automatically marked as deleted (with a tombstone) after the requested amount of time has expired. TIMESTAMP <integer> Defines an optional timestamp to use for the written columns. The timestamp must be in the form of an integer. SET The SET clause is used to specify a comma-separated list of column name/value pairs that you want to update or insert. If the named column exists, its value will be updated. If it does not exist it will be inserted. For counter column families, you can update a counter column value by specifying an increment or decrement value to be applied to the current value of the counter column. WHERE <row_specification>
116
References The WHERE clause identifies one or more rows in the column family for which to update the named columns. Rows are identified using the KEY keyword or the key alias defined on the column family, and then supplying one or more row key values. Example Update a column in several rows at once: UPDATE users USING CONSISTENCY QUORUM SET 'state' = 'TX' WHERE KEY IN (88b8fd18-b1ed-4e96-bf79-4280797cba80, 06a8913c-c0d6-477c-937d-6c1b69a95d43, bc108776-7cb5-477f-917d-869c12dfffa8); Update several columns in a single row: UPDATE users USING CONSISTENCY QUORUM SET 'name' = 'John Smith', 'email' = 'jsmith@cassie.com' WHERE user_uuid = 88b8fd18-b1ed-4e96-bf79-4280797cba80; Update the value of a counter column: UPDATE page_views USING CONSISTENCY QUORUM AND TIMESTAMP=1318452291034 SET 'index.html' = 'index.html' + 1 WHERE KEY = 'www.datastax.com';
USE
Connects the current client session to a keyspace. Synopsis USE <keyspace_name>; Description A USE statement tells the current client session and the connected Cassandra instance what keyspace you will be working in. All subsequent operations on column families and indexes will be in the context of the named keyspace, unless otherwise specified or until the client connection is terminated or another USE statement is issued. Parameters <keyspace_name> The name of the keyspace to connect to for the current client session. Example USE PortfolioDemo;
CQLSH-Specific Commands
CQL Shell (cqlsh) has these additional CQL commands available in the command-line interface: ASSUME Sets the client-side encoding for a cqlsh session.
117
References Synopsis ASSUME [<keyspace_name>].<columnfamily_name> <storage_type_definition> [, ...] ; Where <storage_type_definition> is: .. code-block:: sql (KEY | <column_name>) VALUES ARE <datatype> | NAMES ARE <datatype> | VALUES ARE <datatype> Description Cassandra is a schema-optional data model, meaning that column families are not required to have data type information explicitly defined for column names, column values or row key values. When type information is not explicitly defined, and implicit typing cannot be determined, data is displayed as raw hex bytes (blob type), which is not human-readable. The ASSUME command allows you to specify type information for particular column family values passed between the cqlsh client and the Cassandra server. Parameters [<keyspace_name>].<columnfamily_name> The name of the column family (and optionally the keyspace) for which you are specifying assumed types. If keyspace is not supplied, the keyspace is assumed to be the keyspace you are currently connected to. NAMES ARE <datatype> Used to declare an assumed type for column names. VALUES ARE <datatype> Used to declare an assumed type for column values. (KEY | <column_name>) VALUES ARE <datatype> Used to declare an assumed type for a particular column, such as the row key. If your column family row key does not have a name or alias defined, you can use the KEY keyword to denote the row key. If the row key (or any other column) has a name or alias defined in the column family schema, you can declare it by its name. Examples ASSUME users NAMES ARE text, VALUES are text; ASSUME users(KEY) VALUES are uuid; ASSUME users(user_id) VALUES are uuid; DESCRIBE Outputs information about the connected Cassandra cluster, or about the data objects stored in the cluster. Synopsis DESCRIBE CLUSTER | SCHEMA
118
References
| KEYSPACE [<keyspace_name>] | COLUMNFAMILY <columnfamily_name> Description A DESCRIBE statement outputs information about the currently connected Cassandra cluster and the data objects (keyspaces and column families) stored in the cluster. It outputs CQL statements that can be used to recreate the database schema if needed. Parameters CLUSTER Outputs information about the Cassandra cluster, such as the cluster name, partitioner, and snitch configured for the cluster. When connected to a non-system keyspace, also shows the data endpoint ranges owned by each node in the Cassandra ring. SCHEMA Outputs CQL commands that can be used to recreate the entire schema (all keyspaces and column families managed by the cluster). KEYSPACE [<keyspace_name>] Outputs CQL commands that can be used to recreate the keyspace and its column families. May also show metadata about the keyspace. If a keyspace name is not provided, the current keyspace is described. COLUMNFAMILY <columnfamily_name> Output CQL commands that can be used to recreate the column family schema. May also show metadata about the column family. Examples DESCRIBE CLUSTER; DESCRIBE KEYSPACE PortfolioDemo; DESCRIBE COLUMNFAMILY Stocks; SHOW Shows the Cassandra version, host, or data type assumptions for the current cqlsh client session. Synopsis SHOW VERSION | HOST | ASSUMPTIONS; Description A SHOW statement displays information about the current cqlsh client session, including the Cassandra version, the Cassandra host, and any data type assumptions that have been set. Parameters VERSION
119
References Shows the version and build number of the connected Cassandra instance, as well as the versions of the CQL specification and the Thrift protocol that the connected Cassandra instance understands. HOST Shows the host information of the Cassandra node that the cqlsh session is currently connected to. ASSUMPTIONS Shows the data type assumptions for the current cqlsh session as specified by the ASSUME command. Examples SHOW VERSION; SHOW HOST; SHOW ASSUMPTIONS;
nodetool
Under the bin directory you will find the nodetool utility. This can be used to help manage a cluster. Usage: bin/nodetool -h HOSTNAME [-p JMX_PORT ] COMMAND... If a username and password for RMI authentication are set explicitly in the cassandra-env.sh file for the host, then you must specify credentials: bin/nodetool -h HOSTNAME [-p JMX_PORT -u JMX_USERNAME -p JMX_PASSWORD ] COMMAND... The available commands are: ring Displays node status and information about the ring as determined by the node being queried. This can give you a quick idea of how balanced the load is around the ring and if any nodes are down. If your cluster is not properly configured, different nodes may show a different ring, so this is a good way to check that every node views the ring the same way. join Causes the node to join the ring. This assumes that the node was initially started not in the ring, or in other words, started with -Djoin_ring=false. Note that the joining node should be properly configured with the desired options for seed list, initial token, and autoboostrapping. info Outputs node information including the token, load info (on disk storage), generation number (times started), uptime in seconds, and heap memory usage. cfstats Prints statistics for every keyspace and column family. version Prints the Cassandra release version for the node being queried. cleanup [keyspace][cf_name] Triggers the immediate cleanup of keys no longer belonging to this node. This has roughly the same effect on a node that a major compaction does in terms of a temporary increase in disk space usage and an increase in disk I/O. Optionally takes a list of column family names. compact [keyspace][cf_name]
120
References For column families that use the SizeTieredCompactionStrategy, initiates an immediate major compaction of all column families in keyspace. For each column family in keyspace, this compacts all existing SSTables into a single SSTable. This will cause considerable disk I/O and will temporarily cause up to twice as much disk space to be used. Optionally takes a list of column family names. upgradesstables [keyspace][cf_name] Rebuilds SSTables on a node for the named column families. Use when upgrading your server or changing compression options (available from Cassandra 1.0.4 onwards). scrub [keyspace][cf_name] Rebuilds SSTables on a node for the named column families and snapshots data files before rebuilding as a safety measure. If possible use upgradesstables. While scrub rebuilds SSTables, it also discards data that it deems broken and creates a snapshot, which you have to remove manually. cfhistograms keyspace cf_name Prints statistics on the read/write latency for a column family. These statistics, which include row size, column count and bucket offsets, can be useful for monitoring activity in a column family. snapshot [snapshot-name] Takes an online snapshot of Cassandras data. Before taking the snapshot, the node is flushed. The results can be found in Cassandras data directory (typically /var/lib/cassandra/data) under the snapshots directory of each keyspace. See also: http://wiki.apache.org/cassandra/Operations#Backing_up_data clearsnapshot Deletes all existing snapshots. tpstats Prints the number of active, pending, and completed tasks for each of the thread pools that Cassandra uses for stages of operations. A high number of pending tasks for any pool can indicate performance problems. For more details, see: http://wiki.apache.org/cassandra/Operations#Monitoring flush keyspace [cf_name] Flushes all memtables for a keyspace to disk, allowing the commit log to be cleared. Optionally takes a list of column family names. drain Flushes all memtables for a node and causes the node to stop accepting write operations. Read operations will continue to work. This is typically used before upgrading a node to a new version of Cassandra. repair keyspace [cf_name] [-pr] Begins an anti-entropy node repair operation. If the -pr option is specified, only the first range returned by the partitioner for a node will be repaired. This allows you to repair each node in the cluster in succession without duplicating work. Without -pr, all replica ranges that the node is responsible for will be repaired. Optionally takes a list of column family names. decommission Tells a live node to decommission itself (streaming its data to the next node on the ring) See also: http://wiki.apache.org/cassandra/NodeProbe#Decommission http://wiki.apache.org/cassandra/Operations#Removing_nodes_entirely move new_token
121
References Moves a node to a new token. This essentially combines decommission and bootstrap. See: http://wiki.apache.org/cassandra/Operations#Moving_nodes loadbalance Moves the node to a new token so that it will split the range of whatever token currently has the highest load (this is the same heuristic used for bootstrap). This is rarely called for, as it does not balance the ring in a meaningful way. See Adding Capacity to an Existing Cluster. netstats host Displays network information such as the status of data streaming operations (bootstrap, repair, move and decommission) as well as the number of active, pending and completed commands and responses. removetoken status | force | token Shows status of a current token removal, forces the the completion of a pending removal, or removes a specified token. This tokens range is assumed by another node and the data is streamed there from the remaining live replicas. See: http://wiki.apache.org/cassandra/Operations#Removing_nodes_entirely setcachecapacity keyspace cf_name key_cache_capacity row_cache_capacity Sets the size of the key cache and row cache. These may be either an absolute number or a percentage in the form of a floating point number. invalidatekeycache [keyspace] [cfnames] Invalidates, or deletes, the key cache. Optionally takes a keyspace or list of column family names (leave a blank space between each column family name). invalidaterowcache [keyspace] [cfnames] Invalidates, or deletes, the row cache. Optionally takes a keyspace or list of column family names (leave a blank space between each column family name). getcompactionthreshold keyspace cf_name Gets the current compaction threshold settings for a column family. See: http://wiki.apache.org/cassandra/MemtableSSTable setcompactionthreshold cf_name min_threshold [max_threshold] The min_threshold parameter controls how many SSTables of a similar size must be present before a minor compaction is scheduled. The max_threshold sets an upper bound on the number of SSTables that may be compacted in a single minor compaction. See also: http://wiki.apache.org/cassandra/MemtableSSTable
cassandra
The cassandra utility starts the Cassandra Java server process.
Usage
cassandra [OPTIONS]
Environment
Cassandra requires the following environment variables to be set: JAVA_HOME - The path location of your Java Virtual Machine (JVM) installation CLASSPATH - A path containing all of the required Java class files (.jar) 122
References
CASSANDRA_CONF - Directory containing the Cassandra configuration files For convenience, Cassandra uses an include file, cassandra.in.sh, to source these environment variables. It will check the following locations for this file: Environment setting for CASSANDRA_INCLUDE if set $CASSANDRA_HOME/bin /usr/share/cassandra/cassandra.in.sh /usr/local/share/cassandra/cassandra.in.sh /opt/cassandra/cassandra.in.sh $HOME/.cassandra.in.sh Cassandra also uses the Java options set in $CASSANDRA_CONF/cassandra-env.sh. If you want to pass additional options to the Java virtual machine, such as maximum and minimum heap size, edit the options in that file rather than setting JVM_OPTS in the environment.
Options
-f Start the cassandra process in foreground (default is to start as a background process). -p <filename> Log the process ID in the named file. Useful for stopping Cassandra by killing its PID. -v Print the version and exit. -D <parameter>
123
References Passes in one of the following startup parameters: Parameter access.properties=<filename> cassandra-pidfile=<filename> cassandra.config=<directory> cassandra.initial_token=<token> cassandra.join_ring=<true|false> cassandra.load_ring_state= <true|false> cassandra.renew_counter_id= <true|false> Description The file location of the access.properties file. Log the Cassandra server process ID in the named file. Useful for stopping Cassandra by killing its PID. The directory location of the Cassandra configuration files. Sets the initial partitioner token for a node the first time the node is started. Set to false to start Cassandra on a node but not have the node join the cluster. Set to false to clear all gossip state for the node on restart. Use if youhave changed node information in cassandra.yaml (such as listen_address). Set to true to reset local counter info on a node. Used to recover from data loss to a counter column family. First remove all SSTables for counter column families on the node, then restart the node with -Dcassandra.renew_counter_id=true, then run nodetool repair once the node is up again. To replace a node that has died, restart a new node in its place and use this parameter to pass in the token that the new node is assuming. The new node must not have any data in its data directory and the token passed must already be a token that is part of the ring.
cassandra.replace_token=<token>
cassandra.framed cassandra.host cassandra.port=<port> cassandra.rpc_port=<port> cassandra.start_rpc=<true|false> cassandra.storage_port=<port> corrupt-sstable-root legacy-sstable-root mx4jaddress mx4jport passwd.mode passwd.properties=<file>
Examples
Start Cassandra on a node and log its PID to a file: cassandra -p ./cassandra.pid Clear gossip state when starting a node. This is useful if the node has changed its configuration, such as its listen IP address: cassandra -Dcassandra.load_ring_state=false Start Cassandra on a node in stand-alone mode (do not join the cluster configured in the cassandra.yaml file): cassandra -Dcassandra.join_ring=false
124
References
stress
The /tools/stress directory contains the Java-based stress testing utilities that can help in benchmarking and load testing a Cassandra cluster: stress.java and the daemon stressd. The daemon mode, which keeps the JVM warm more efficiently, may be useful for large-scale benchmarking.
Usage
There are three different modes of operation: inserting (loading test data) reading range slicing (only works with the OrderPreservingPartioner) indexed range slicing (works with RandomParitioner on indexed ColumnFamiles). You can use these modes with or without the stressd daemon running. For larger-scale testing, the daemon can yield better performance by keeping the JVM warm and preventing potential skew in test results. If no specific operation is specified, stress will insert 1M rows. The options available are: -o <operation>, --operation <operation> Sets the operation mode, one of 'insert', 'read', 'rangeslice', or 'indexedrangeslice' -T <IP>, --send-to <IP> Sends the command as a request to the stress daemon at the specified IP address. The daemon must already be running at that address. -n <NUMKEYS>, --num-keys <NUMKEYS> Number of keys to write or read. Default is 1,000,000. -l <RF>, --replication-factor <RF> Replication Factor to use when creating needed column families. Defaults to 1. -R <strategy>, --replication-strategy <strategy> Replication strategy to use (only on is:org.apache.cassandra.locator.SimpleStrategy. -O <properties>, --strategy-properties <properties> Replication strategy properties in the following format <dc_name>:<num>,<dc_name>:<num>,... Use with network topology strategy. -W, --no-replicate-on-write Set replicate_on_write to false for counters. Only for counters add with CL=ONE. -e <CL>, --consistency-level <CL> Consistency Level to use (ONE, QUORUM, LOCAL_QUORUM, EACH_QUORUM, ALL, ANY). Default is ONE. -c <COLUMNS>, --columns <COLUMNS> insert when keyspace does not exist. Default
125
References Number of columns per key. Default is 5. -d <NODES>, --nodes <NODES> Nodes to perform the test against.(comma separated, no spaces). Default is localhost. -y <TYPE>, --family-type <TYPE> Sets the ColumnFamily type. One of 'Standard' or 'Super'. If using super, set the -u option also. -V, --average-size-values Generate column values of average rather than specific size. -u <SUPERCOLUMNS>, --supercolumns <SUPERCOLUMNS> Use the number of supercolumns specified. You must set the -y option appropriately, or this option has no effect. -g <COUNT>, --get-range-slice-count <COUNT> Sets the number of rows to slice at a time and defaults to 1000. This is only used for the rangeslice operation and will NOT work with the RandomPartioner. You must set the OrderPreservingPartioner in your storage configuration (note that you will need to wipe all existing data when switching partioners.) -g <KEYS>, --keys-per-call <KEYS> Number of keys to get_range_slices or multiget per call. Default is 1000. -r, --random Only used for reads. By default, stress will perform reads on rows with a Guassian distribution, which will cause some repeats. Setting this option makes the reads completely random instead. -i, --progress-interval The interval, in seconds, at which progress will be output.
Examples
1M inserts to given host: /tools/stress/bin/stress -d 192.168.1.101 1M reads from given host: tools/stress/bin/stress -d 192.168.1.101 -o read 10M inserts spread across two nodes: /tools/stress/bin/stress -d 192.168.1.101,192.168.1.102 -n 10000000 10M inserts spread across two nodes using the daemon mode: /tools/stress/bin/stress -d 192.168.1.101,192.168.1.102 -n 10000000 -T 54.0.0.1
sstable2json / json2sstable
The utility sstable2json converts the on-disk SSTable representation of a column family into a JSON formatted document. Its counterpart, json2sstable , does exactly the opposite: it converts a JSON representation of a column family to a Cassandra usable SSTable format. Converting SSTables this way can be useful for testing and debugging. 126
References
Note
Starting with version 0.7, json2sstable and sstable2json must be run in such a way that the schema can be loaded from system tables. This means that cassandra.yaml must be found in the classpath and refer to valid storage directories. See also: The Import/Export section of http://wiki.apache.org/cassandra/Operations.
sstable2json
This converts the on-disk SSTable representation of a column family into a JSON formatted document.
Usage
bin/sstable2json [-f OUT_FILE] SSTABLE [-k KEY [-k KEY [...]]]] [-x KEY [-x KEY [...]]] [-e] SSTABLE should be a full path to a column-family-name-Data.db file in Cassandras data directory. For example, /var/lib/cassandra/data/Keyspace1/Standard1-e-1-Data.db. -k allows you to include a specific set of keys. Limited to 500 keys. -x allows you to exclude a specific set of keys. Limited to 500 keys. -e causes keys to only be enumerated
Output Format
The output of sstable2json for standard column families is: { ROW_KEY: { [ [COLUMN_NAME, COLUMN_VALUE, COLUMN_TIMESTAMP, IS_MARKED_FOR_DELETE], [COLUMN_NAME, ... ], ... ] }, ROW_KEY: { ... }, ... } The output for super column families is: { ROW_KEY: { SUPERCOLUMN_NAME: { deletedAt: DELETION_TIME, subcolumns: [ [COLUMN_NAME, COLUMN_VALUE, COLUMN_TIMESTAMP, IS_MARKED_FOR_DELETE], [COLUMN_NAME, ... ], ...
127
Troubleshooting Guide
] }, SUPERCOLUMN_NAME: { ... }, ... }, ROW_KEY: { ... }, ... } Row keys, column names and values are written in as the hex representation of their byte arrays. Line breaks are only in between row keys in the actual output.
json2sstable
This converts a JSON representation of a column family to a Cassandra usable SSTable format.
Usage
bin/json2sstable -K KEYSPACE -c COLUMN_FAMILY JSON SSTABLE JSON should be a path to the JSON file SSTABLE should be a full path to a column-family-name-Data.db file in Cassandras data directory. For example, /var/lib/cassandra/data/Keyspace1/Standard1-e-1-Data.db.
sstablekeys
The sstablekeys utility is shorthand for sstable2json with the -e option. Instead of dumping all of a column familys data, it dumps only the keys.
Usage
bin/sstablekeys SSTABLE SSTABLE should be a full path to a column-family-name-Data.db file in Cassandras data directory. For example, /var/lib/cassandra/data/Keyspace1/Standard1-e-1-Data.db.
Troubleshooting Guide
This page contains recommended fixes and workarounds for issues commonly encountered with Cassandra: Reads are getting slower while writes are still fast Nodes seem to freeze after some period of time Nodes are dying with OOM errors Nodetool or JMX connections failing on remote nodes View of ring differs between some nodes Java reports an error saying there are too many open files Cannot initialize class org.xerial.snappy.Snappy 128
Troubleshooting Guide
129
Troubleshooting Guide This is an indication that the ring is in a bad state. This can happen when there are token conflicts (for instance, when bootstrapping two nodes simultaneously with automatic token selection.) Unfortunately, the only way to resolve this is to do a full cluster restart; a rolling restart is insufficient since gossip from nodes with the bad state will repopulate it on newly booted nodes.
Java reports an error saying there are too many open files
One possibility is that Java is not allowed to open enough file descriptors. Cassandra generally needs more than the default (1024) amount. This can be adjusted by increasing the security limits on your Cassandra nodes. For example, using the following commands: echo echo echo echo "* soft nofile 32768" | sudo tee -a "* hard nofile 32768" | sudo tee -a "root soft nofile 32768" | sudo tee "root hard nofile 32768" | sudo tee /etc/security/limits.conf /etc/security/limits.conf -a /etc/security/limits.conf -a /etc/security/limits.conf
Another, much less likely possibility, is a file descriptor leak in Cassandra. See if the number of file descriptors opened by java seems reasonable when running lsof -n | grep java and report the error if the number is greater than a few thousand.
The native library snappy-1.0.4.1-libsnappyjava.so for Snappy compression is included in the snappy-java-1.0.4.1.jar file. When the JVM initializes the JAR, the library is added to the default temp directory. If the default temp directory is mounted with a noexec option, it results in the above exception. One solution is to specify a different temp directory that has already been mounted without the noexec option, as follows: If you use the DSE/Cassandra command $_BIN/dse cassandra or $_BIN/cassandra, simply append the command line: DSE: ./bin/dse cassandra -t -Dorg.xerial.snappy.tempdir=/path/to/newtmp Cassandra: ./bin/cassandra -Dorg.xerial.snappy.tempdir=/path/to/newtmp If starting from a package using service dse start or service cassandra start, add a system environment variable JVM_OPTS with the value: JVM_OPTS=-Dorg.xerial.snappy.tempdir=/path/to/newtmp The default cassandra-env.sh looks for the variable and appends to it when starting the JVM.
130