PutCassandraRecord

Description:

This is a record aware processor that reads the content of the incoming FlowFile as individual records using the configured 'Record Reader' and writes them to Apache Cassandra using native protocol version 3 or higher.

Tags:

cassandra, cql, put, insert, update, set, record

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
Cassandra Connection Provider	cassandra-connection-provider		Controller Service API: CassandraSessionProviderService Implementation: CassandraSessionProvider	Specifies the Cassandra connection providing controller service to be used to connect to Cassandra cluster.
Cassandra Contact Points	Cassandra Contact Points			Contact points are addresses of Cassandra nodes. The list of contact points should be comma-separated and in hostname:port format. Example node1:port,node2:port,.... The default client port for Cassandra is 9042, but the port(s) must be explicitly specified. Supports Expression Language: true (will be evaluated using variable registry only)
Keyspace	Keyspace			The Cassandra Keyspace to connect to. If no keyspace is specified, the query will need to include the keyspace name before any table reference, in case of 'query' native processors or if the processor exposes the 'Table' property, the keyspace name has to be provided with the table name in the form of <KEYSPACE>.<TABLE> Supports Expression Language: true (will be evaluated using variable registry only)
Table name	put-cassandra-record-table			The name of the Cassandra table to which the records have to be written. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Statement Type	put-cassandra-record-statement-type	INSERT	UPDATE INSERT Use cql.statement.type Attribute	Specifies the type of CQL Statement to generate.
Update Keys	put-cassandra-record-update-keys			A comma-separated list of column names that uniquely identifies a row in the database for UPDATE statements. If the Statement Type is UPDATE and this property is not set, the conversion to CQL will fail. This property is ignored if the Statement Type is not UPDATE. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Update Method	put-cassandra-record-update-method	Set	Increment Decrement Set Use cql.update.method Attribute	Specifies the method to use to SET the values. This property is used if the Statement Type is UPDATE and ignored otherwise.
Client Auth	Client Auth	REQUIRED	WANT REQUIRED NONE	Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.
Username	Username			Username to access the Cassandra cluster Supports Expression Language: true (will be evaluated using variable registry only)
Password	Password			Password to access the Cassandra cluster Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)
Record Reader	put-cassandra-record-reader		Controller Service API: RecordReaderFactory Implementations: GrokReader JsonTreeReader WindowsEventLogReader ReaderLookup ParquetReader CSVReader Syslog5424Reader ExcelReader CEFReader XMLReader ScriptedReader SyslogReader JsonPathReader AvroReader YamlTreeReader	Specifies the type of Record Reader controller service to use for parsing the incoming data and determining the schema
Batch size	put-cassandra-record-batch-size	100		Specifies the number of 'Insert statements' to be grouped together to execute as a batch (BatchStatement) Supports Expression Language: true (will be evaluated using variable registry only)
Consistency Level	Consistency Level	SERIAL	SERIAL LOCAL_SERIAL	The strategy for how many replicas must respond before results are returned.
Batch Statement Type	put-cassandra-record-batch-statement-type	LOGGED	LOGGED UNLOGGED COUNTER Use cql.batch.statement.type Attribute	Specifies the type of 'Batch Statement' to be used.
SSL Context Service	SSL Context Service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	The SSL Context Service used to provide client certificate information for TLS/SSL connections.

Relationships:

Name	Description
success	A FlowFile is transferred to this relationship if the operation completed successfully.
failure	A FlowFile is transferred to this relationship if the operation failed.

Reads Attributes:

Name	Description
cql.statement.type	If 'Use cql.statement.type Attribute' is selected for the Statement Type property, the value of the cql.statement.type Attribute will be used to determine which type of statement (UPDATE, INSERT) will be generated and executed
cql.update.method	If 'Use cql.update.method Attribute' is selected for the Update Method property, the value of the cql.update.method Attribute will be used to determine which operation (Set, Increment, Decrement) will be used to generate and execute the Update statement. Ignored if the Statement Type property is not set to UPDATE
cql.batch.statement.type	If 'Use cql.batch.statement.type Attribute' is selected for the Batch Statement Type property, the value of the cql.batch.statement.type Attribute will be used to determine which type of batch statement (LOGGED, UNLOGGED, COUNTER) will be generated and executed

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.