ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla C/C++ Driver API Documentation CassCustomPayload

CassCustomPayload¶

struct CassCustomPayload¶

Requires Apache Cassandra: 2.2+

Public Functions

CassCustomPayload *cass_custom_payload_new()¶

Creates a new custom payload.

Requires Apache Cassandra: 2.2+

See also

cass_custom_payload_free()

Returns:

Returns a custom payload that must be freed.

void cass_custom_payload_free(CassCustomPayload *payload)¶

Frees a custom payload instance.

Requires Apache Cassandra: 2.2+

Parameters:

payload – [in]

void cass_custom_payload_set(CassCustomPayload *payload, const char *name, const cass_byte_t *value, size_t value_size)¶

Sets an item to the custom payload.

Requires Apache Cassandra: 2.2+

Parameters:
  • payload – [in]

  • name – [in]

  • value – [in]

  • value_size – [in]

void cass_custom_payload_set_n(CassCustomPayload *payload, const char *name, size_t name_length, const cass_byte_t *value, size_t value_size)¶

Same as cass_custom_payload_set(), but with lengths for string parameters.

Requires Apache Cassandra: 2.2+

Parameters:
  • payload – [in]

  • name – [in]

  • name_length – [in]

  • value – [in]

  • value_size – [in]

void cass_custom_payload_remove(CassCustomPayload *payload, const char *name)¶

Removes an item from the custom payload.

Requires Apache Cassandra: 2.2+

Parameters:
  • payload – [in]

  • name – [in]

void cass_custom_payload_remove_n(CassCustomPayload *payload, const char *name, size_t name_length)¶

Same as cass_custom_payload_set(), but with lengths for string parameters.

Requires Apache Cassandra: 2.2+

Parameters:
  • payload – [in]

  • name – [in]

  • name_length – [in]

Was this page helpful?

PREVIOUS
CassColumnMeta
NEXT
CassDataType
  • Create an issue
  • Edit this page

On this page

  • CassCustomPayload
    • CassCustomPayload
      • CassCustomPayload::cass_custom_payload_new()
      • CassCustomPayload::cass_custom_payload_free()
      • CassCustomPayload::cass_custom_payload_set()
      • CassCustomPayload::cass_custom_payload_set_n()
      • CassCustomPayload::cass_custom_payload_remove()
      • CassCustomPayload::cass_custom_payload_remove_n()
Scylla C/C++ Driver
  • master
    • master
  • C/C++ Driver for ScyllaDB
  • API Documentation
    • CassAggregateMeta
    • CassAuthenticator
    • CassAuthenticatorCallbacks
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassLogMessage
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • CassSpeculativeExecutionMetrics
    • CassSsl
    • CassStatement
    • CassTableMeta
    • CassTimestampGen
    • CassTuple
    • CassUserType
    • CassUuid
    • CassUuidGen
    • CassValue
    • CassVersion
    • DseDateRange
    • DseDateRangeBound
    • DseLineString
    • DseLineStringIterator
    • DsePolygon
    • DsePolygonIterator
  • Features
    • Basics
      • Batches
      • Binding Parameters
      • Client-side timestamps
      • Consistency
      • Data Types
      • The date and time Types
      • Futures
      • Handling Results
      • Keyspaces
      • Prepared Statements
      • Schema Metadata
      • Tuples
      • User-Defined Types (UDTs)
      • UUIDs
    • Building
    • Client Configuration
    • Cloud
    • Configuration
      • Retry policies
    • Execution Profiles
    • FAQ
    • Installation
    • Logging
    • Metrics
    • Scylla Specific Features
    • Security
      • SSL
    • Testing
      • Cassandra Cluster Manager (CCM)
    • Tracing
  • DSE Features
    • Authentication
    • Geospatial types
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 28 April 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6