class Cassandra
Copyright 2017 DataStax, Inc.
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The main entry point to the PHP Driver for Apache Cassandra.
Use Cassandra::cluster() to build a cluster instance. Use Cassandra::ssl() to build SSL options instance.
Constants
CONSISTENCY_ANY
= 0
Consistency level ANY means the request is fulfilled as soon as the data has been written on the Coordinator. Requests with this consistency level are not guranteed to make it to Replica nodes.
CONSISTENCY_ONE
= 1
Consistency level ONE guarantees that data has been written to at least one Replica node.
CONSISTENCY_TWO
= 2
Consistency level TWO guarantees that data has been written to at least two Replica nodes.
CONSISTENCY_THREE
= 3
Consistency level THREE guarantees that data has been written to at least three Replica nodes.
CONSISTENCY_QUORUM
= 4
Consistency level QUORUM guarantees that data has been written to at least the majority of Replica nodes. How many nodes exactly are a majority depends on the replication factor of a given keyspace and is calculated using the formula ceil(RF / 2 + 1), where ceil is a mathematical ceiling function and RF is the replication factor used. For example, for a replication factor of 5, the majority is ceil(5 / 2 + 1) = 3.
CONSISTENCY_ALL
= 5
Consistency level ALL guarantees that data has been written to all Replica nodes.
CONSISTENCY_LOCAL_QUORUM
= 6
Same as CONSISTENCY_QUORUM, but confined to the local data center. This consistency level works only with NetworkTopologyStrategy replication.
CONSISTENCY_EACH_QUORUM
= 7
Consistency level EACH_QUORUM guarantees that data has been written to at least a majority Replica nodes in all datacenters. This consistency level works only with NetworkTopologyStrategy replication.
CONSISTENCY_SERIAL
= 8
This is a serial consistency level, it is used in conditional updates, e.g. (CREATE|INSERT ... IF NOT EXISTS), and should be specified as the serial_consistency execution option when invoking session.execute or session.execute_async.
Consistency level SERIAL, when set, ensures that a Paxos commit fails if any of the replicas is down.
CONSISTENCY_LOCAL_SERIAL
= 9
Same as CONSISTENCY_SERIAL, but confined to the local data center. This consistency level works only with NetworkTopologyStrategy replication.
CONSISTENCY_LOCAL_ONE
= 10
Same as CONSISTENCY_ONE, but confined to the local data center. This consistency level works only with NetworkTopologyStrategy replication.
VERIFY_NONE
= 0
Perform no verification of nodes when using SSL encryption.
VERIFY_PEER_CERT
= 1
Verify presence and validity of SSL certificates.
VERIFY_PEER_IDENTITY
= 2
Verify that the IP address matches the SSL certificate’s common name or one of its subject alternative names. This implies the certificate is also present.
BATCH_LOGGED
= 0
BATCH_UNLOGGED
= 1
BATCH_COUNTER
= 2
LOG_DISABLED
= 0
Used to disable logging.
LOG_CRITICAL
= 1
Allow critical level logging.
LOG_ERROR
= 2
Allow error level logging.
LOG_WARN
= 3
Allow warning level logging.
LOG_INFO
= 4
Allow info level logging.
LOG_DEBUG
= 5
Allow debug level logging.
LOG_TRACE
= 6
Allow trace level logging.
TYPE_TEXT
= ‘text’
When using a map, collection or set of type text, all of its elements must be strings.
TYPE_ASCII
= ‘ascii’
When using a map, collection or set of type ascii, all of its elements must be strings.
TYPE_VARCHAR
= ‘varchar’
When using a map, collection or set of type varchar, all of its elements must be strings.
TYPE_BIGINT
= ‘bigint’
When using a map, collection or set of type bigint, all of its elements must be instances of Cassandra\Bigint.
TYPE_SMALLINT
= ‘smallint’
When using a map, collection or set of type smallint, all of its elements must be instances of Cassandra\Inet.
TYPE_TINYINT
= ‘tinyint’
When using a map, collection or set of type tinyint, all of its elements must be instances of Cassandra\Inet.
TYPE_BLOB
= ‘blob’
When using a map, collection or set of type blob, all of its elements must be instances of Cassandra\Blob.
TYPE_BOOLEAN
= ‘boolean’
When using a map, collection or set of type bool, all of its elements must be boolean.
TYPE_COUNTER
= ‘counter’
When using a map, collection or set of type counter, all of its elements must be instances of Cassandra\Bigint.
TYPE_DECIMAL
= ‘decimal’
When using a map, collection or set of type decimal, all of its elements must be instances of Cassandra\Decimal.
TYPE_DOUBLE
= ‘double’
When using a map, collection or set of type double, all of its elements must be doubles.
TYPE_FLOAT
= ‘float’
When using a map, collection or set of type float, all of its elements must be instances of Cassandra\Float.
TYPE_INT
= ‘int’
When using a map, collection or set of type int, all of its elements must be ints.
TYPE_TIMESTAMP
= ‘timestamp’
When using a map, collection or set of type timestamp, all of its elements must be instances of Cassandra\Timestamp.
TYPE_UUID
= ‘uuid’
When using a map, collection or set of type uuid, all of its elements must be instances of Cassandra\Uuid.
TYPE_VARINT
= ‘varint’
When using a map, collection or set of type varint, all of its elements must be instances of Cassandra\Varint.
TYPE_TIMEUUID
= ‘timeuuid’
When using a map, collection or set of type timeuuid, all of its elements must be instances of Cassandra\Timeuuid.
TYPE_INET
= ‘inet’
When using a map, collection or set of type inet, all of its elements must be instances of Cassandra\Inet.
VERSION
= ‘1.3.1’
The current version of the extension.
CPP_DRIVER_VERSION
= ‘2.7.0’
The version of the cpp-driver the extension is compiled against.
Methods
Cluster\Builder cluster
( )Creates a new cluster builder for constructing a Cassandra\Cluster object.
- Static
- This method is static
SSLOptions\Builder ssl
( )Creates a new ssl builder for constructing a Cassandra\SSLOptions object.
- Static
- This method is static