Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla C/C++ Driver Documentation API Documentation CassPrepared

CassPrepared¶

struct CassPrepared¶

A statement that has been prepared cluster-side (It has been pre-parsed and cached).

A prepared statement is read-only and it is thread-safe to concurrently bind new statements.

Public Functions

void cass_prepared_free(const CassPrepared *prepared)¶

Frees a prepared instance.

Parameters

prepared – [in]

CassStatement *cass_prepared_bind(const CassPrepared *prepared)¶

Creates a bound statement from a pre-prepared statement.

See also

cass_statement_free()

Parameters

prepared – [in]

Returns

Returns a bound statement that must be freed.

CassError cass_prepared_parameter_name(const CassPrepared *prepared, size_t index, const char **name, size_t *name_length)¶

Gets the name of a parameter at the specified index.

Parameters
  • prepared – [in]

  • index – [in]

  • name – [out]

  • name_length – [out]

Returns

CASS_OK if successful, otherwise an error occurred.

const CassDataType *cass_prepared_parameter_data_type(const CassPrepared *prepared, size_t index)¶

Gets the data type of a parameter at the specified index.

Parameters
  • prepared – [in]

  • index – [in]

Returns

Returns a reference to the data type of the parameter. Do not free this reference as it is bound to the lifetime of the prepared.

const CassDataType *cass_prepared_parameter_data_type_by_name(const CassPrepared *prepared, const char *name)¶

Gets the data type of a parameter for the specified name.

Parameters
  • prepared – [in]

  • name – [in]

Returns

Returns a reference to the data type of the parameter. Do not free this reference as it is bound to the lifetime of the prepared.

const CassDataType *cass_prepared_parameter_data_type_by_name_n(const CassPrepared *prepared, const char *name, size_t name_length)¶

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

See also

cass_prepared_parameter_data_type_by_name()

Parameters
  • prepared – [in]

  • name – [in]

  • name_length – [in]

Returns

Returns a reference to the data type of the parameter. Do not free this reference as it is bound to the lifetime of the prepared.

PREVIOUS
CassNode
NEXT
CassResult
  • master
    • master
  • C/C++ Driver for ScyllaDB
  • API Documentation
    • CassAggregateMeta
    • CassAuthenticator
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • 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
  • Create an issue
  • Edit this page
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 18 October 2022.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.1