Main Content

CassandraConnectionOptions

Apache Cassandra database connection options

Description

Create connection options for an Apache Cassandra® database connection.

After you create an CassandraConnectionOptions object, set the connection options, test the connection, and save the data source, you can create an Apache Cassandra database connection using the saved data source. The connection options include the options required to make a Cassandra database connection.

Creation

To create a CassandraConnectionOptions object, use the databaseConnectionOptions function.

Properties

expand all

Data source name, specified as a string scalar. You can use the data source name in the apacheCassandra function to create a Cassandra database connection.

Example: "ApacheCassandra"

Data Types: string

This property is read-only.

Database vendor, specified as a string scalar. Set this property using the vendor input argument in the databaseConnectionOptions function.

Example: "Cassandra"

Data Types: string

Contact points that are host addresses for one node or for multiple nodes in the Cassandra cluster, specified as a string scalar or string array. Specify a string scalar for one node. Or, specify a string array for multiple nodes.

You can specify a local host or the IP address of a different machine in the Cassandra cluster.

When you specify multiple nodes, if the connection to one host fails, then the apacheCassandra function connects to the other nodes in the cell array or string array until a connection succeeds. If a connection attempt fails for all specified nodes, the function displays an error message. If one or more nodes are not available, enter multiple nodes in the string array to increase the likelihood of a successful connection.

Data Types: string

Port number for connection to the host, specified as a positive numeric scalar.

Data Types: double

SSL-enabled connection, specified as the value false or true. Setting this argument to true creates an SSL-enabled connection to the Cassandra database.

Data Types: logical

Login timeout, specified as a positive numeric scalar. The login timeout specifies the number of seconds that the C++ driver waits while trying to connect to the Cassandra database before throwing an error.

Data Types: double

This property is read-only.

Request timeout, specified as a positive numeric scalar. The request timeout indicates the number of seconds the database waits to return a CQL query before throwing an error.

Data Types: double

Object Functions

setoptionsSet Apache Cassandra database connection options
testConnectionTest Apache Cassandra database connection
resetReset Apache Cassandra database connection options to defaults
saveAsDataSourceSave Apache Cassandra data source

Examples

collapse all

Configure an Apache™ Cassandra® database connection by creating a Cassandra data source, setting the Cassandra connection options, and saving the data source.

Create a Cassandra data source for a Cassandra database connection.

vendor = "Cassandra";
opts = databaseConnectionOptions("native",vendor)
opts = 
  CassandraConnectionOptions with properties:

              DataSourceName: ""
                      Vendor: "Cassandra"

               ContactPoints: "localhost"
                  PortNumber: 9042
                  SSLEnabled: false
                LoginTimeout: 5
              RequestTimeout: 12

opts is an CassandraConnectionOptions object with these properties:

  • DataSourceName — Name of the data source

  • Vendor — Database vendor name

  • ContactPoints — Contact points

  • PortNumber — Port number

  • SSLEnabled — SSL-enabled connection

  • LoginTimeout — Login timeout

  • RequestTimeout — Request timeout

Configure the data source by setting the Cassandra connection options for the data source CassandraDataSource, local host address for one node in the cluster, port number 9042, SSL encryption that is disabled, login timeout of 5 seconds, and request timeout of 12 seconds.

opts = setoptions(opts, ...
    "DataSourceName","CassandraDataSource", ...
    "ContactPoints","localhost","PortNumber",9042, ...
    "SSLEnabled",false,"LoginTimeout",5, ...
    "RequestTimeout",12)
opts = 
  CassandraConnectionOptions with properties:

              DataSourceName: "CassandraDataSource"
                      Vendor: "Cassandra"

               ContactPoints: "localhost"
                  PortNumber: 9042
                  SSLEnabled: false
                LoginTimeout: 5
              RequestTimeout: 12

The setoptions function sets the DataSourceName, ContactPoints, PortNumber, SSLEnabled, LoginTimeout, and RequestTimeout properties in the CassandraConnectionOptions object.

Test the database connection with a blank user name and password. The testConnection function returns the logical 1, which indicates the database connection is successful.

username = "";
password = "";
status = testConnection(opts,username,password)
status = logical
   1

Save the configured data source.

saveAsDataSource(opts)

Version History

Introduced in R2021a