tests/src/integration/objects/statement.hpp

/*
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you 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.
*/

#ifndef __TEST_STATEMENT_HPP__
#define __TEST_STATEMENT_HPP__
#include "cassandra.h"

#include "objects/object_base.hpp"

#include "objects/execution_profile.hpp"
#include "objects/future.hpp"
#include "objects/retry_policy.hpp"

#include "testing.hpp"

#include <gtest/gtest.h>

namespace test { namespace driver {

// Forward declaration for circular dependency
class CustomPayload;
class Result;

/**
 * Wrapped statement object
 */
class Statement : public Object<CassStatement, cass_statement_free> {
public:
  /**
   * Create an empty statement
   */
  Statement()
      : Object<CassStatement, cass_statement_free>() {}
  /**
   * Create the statement object from the native driver statement object
   *
   * @param statement Native driver object
   */
  Statement(CassStatement* statement)
      : Object<CassStatement, cass_statement_free>(statement) {}

  /**
   * Create the statement object from the shared reference
   *
   * @param statement Shared reference
   */
  Statement(Ptr statement)
      : Object<CassStatement, cass_statement_free>(statement) {}

  /**
   * Create the statement object from a query
   *
   * @param query Query to create statement from
   * @param parameter_count Number of parameters contained in the query
   *                        (default: 0)
   */
  Statement(const std::string& query, size_t parameter_count = 0)
      : Object<CassStatement, cass_statement_free>(
            cass_statement_new(query.c_str(), parameter_count)) {}

  /**
   * Add a key index specifier to the statement.
   *
   * When using token-aware routing, this can be used to tell the driver which
   * parameters within a non-prepared, parameterized statement are part of
   * the partition key.
   *
   * @param index Index to add key index to
   */
  void add_key_index(size_t index) {
    ASSERT_EQ(CASS_OK, cass_statement_add_key_index(get(), index));
  }

  /**
   * Bind a value to the statement
   *
   * @param index Index to bind the value to
   * @param value<T> Value to bind to the statement at given index
   */
  template <typename T>
  void bind(size_t index, T value) {
    value.statement_bind(*this, index);
  }

  /**
   * Bind a value to the statement by name
   *
   * @param name Column name to bind the value to
   * @param value<T> Value to bind to the statement at given index
   */
  template <typename T>
  void bind(const std::string& name, T value) {
    value.statement_bind(*this, name);
  }

  /**
   * Get the statement's consistency level
   *
   * @return Consistency in use by the statement
   */
  CassConsistency consistency() { return datastax::internal::testing::get_consistency(get()); }

  /**
   * Get the statement's request timeout
   *
   * @return Request timeout (in milliseconds) in by for the statement
   */
  uint64_t request_timeout_ms() {
    return datastax::internal::testing::get_request_timeout_ms(get());
  }

  /**
   * Get the statement's retry policy
   *
   * @return Retry policy in use by the statement
   */
  const CassRetryPolicy* retry_policy() {
    return datastax::internal::testing::get_retry_policy(get());
  }

  /**
   * Get the statement's serial consistency level
   *
   * @return Serial consistency in use by the statement
   */
  CassConsistency serial_consistency() {
    return datastax::internal::testing::get_serial_consistency(get());
  }

  /**
   * Assign/Set the statement's consistency level
   *
   * @param consistency Consistency to use for the statement
   */
  void set_consistency(CassConsistency consistency) {
    ASSERT_EQ(CASS_OK, cass_statement_set_consistency(get(), consistency));
  }

  /**
   * Assign/Set the statement's custom payload
   *
   * @param custom_payload Custom payload to use for the statement
   */
  void set_custom_payload(CustomPayload custom_payload);

  /**
   * Set the execution profile to execute the statement with
   *
   * @param name Execution profile to assign during execution of statement
   */
  void set_execution_profile(const std::string& name) {
    ASSERT_EQ(CASS_OK, cass_statement_set_execution_profile(get(), name.c_str()));
  }

  /**
   * Enable/Disable whether the statement is idempotent. Idempotent statements
   * are able to be automatically retried after timeouts/errors and can be
   * speculatively executed.
   *
   * @param enable True if statement is idempotent; false otherwise
   */
  void set_idempotent(bool enable) {
    ASSERT_EQ(CASS_OK, cass_statement_set_is_idempotent(get(), enable ? cass_true : cass_false));
  }

  /**
   * Sets the statement's keyspace
   *
   * @param keyspace Keyspace to use when executing the statement
   */
  void set_keyspace(const std::string& keyspace) {
    ASSERT_EQ(CASS_OK, cass_statement_set_keyspace(get(), keyspace.c_str()));
  }

  /**
   * Enable/Disable the statement's recording of hosts attempted during its
   * execution
   *
   * @param enable True if attempted host should be recorded; false otherwise
   */
  void set_record_attempted_hosts(bool enable) {
    return datastax::internal::testing::set_record_attempted_hosts(get(), enable);
  }

  /**
   * Assign/Set the timeout for statement execution
   *
   * @param timeout_ms Timeout in milliseconds
   */
  void set_request_timeout(uint64_t timeout_ms) {
    ASSERT_EQ(CASS_OK, cass_statement_set_request_timeout(get(), timeout_ms));
  }

  /**
   * Assign/Set the statement's retry policy
   *
   * @param retry_policy Retry policy to use for the statement
   */
  void set_retry_policy(RetryPolicy retry_policy) {
    ASSERT_EQ(CASS_OK, cass_statement_set_retry_policy(get(), retry_policy.get()));
  }

  /**
   * Assign/Set the statement's serial consistency level
   *
   * @param serial_consistency Serial consistency to use for the statement
   */
  void set_serial_consistency(CassConsistency serial_consistency) {
    ASSERT_EQ(CASS_OK, cass_statement_set_serial_consistency(get(), serial_consistency));
  }

  /**
   * Sets the statement's timestamp
   *
   * @param timestamp Timestamp (in milliseconds) to apply to the statement
   */
  void set_timestamp(int64_t timestamp_ms) {
    ASSERT_EQ(CASS_OK, cass_statement_set_timestamp(get(), timestamp_ms));
  }

  /**
   * Enable/Disable tracing.
   *
   * @param enabled
   */
  void set_tracing(bool enabled) {
    ASSERT_EQ(CASS_OK, cass_statement_set_tracing(get(), enabled ? cass_true : cass_false));
  }

  /**
   * Set host to run statement on.
   *
   * @param host
   * @param port
   */
  void set_host(const std::string& host, int port) {
    ASSERT_EQ(CASS_OK, cass_statement_set_host(get(), host.c_str(), port));
  }

  /**
   * Set host to run statement on using `CassInet` type.
   *
   * @param host
   * @param port
   */
  void set_host(const CassInet* host, int port) {
    ASSERT_EQ(CASS_OK, cass_statement_set_host_inet(get(), host, port));
  }

  /**
   * Set node to run statement on use `CassNode` type.
   *
   * @param node
   */
  void set_node(const CassNode* node) { ASSERT_EQ(CASS_OK, cass_statement_set_node(get(), node)); }

  /**
   * Set the paging size for the statement.
   *
   * @param page_size
   */
  void set_paging_size(int page_size) {
    ASSERT_EQ(CASS_OK, cass_statement_set_paging_size(get(), page_size));
  }

  /**
   * Set the paging state for the statement.
   *
   * @param result
   */
  void set_paging_state(const Result& result);

  /**
   * Set the raw paging state token for the statement.
   *
   * @param token
   */
  void set_paging_state_token(const std::string& token) {
    ASSERT_EQ(CASS_OK, cass_statement_set_paging_state_token(get(), token.c_str(), token.size()));
  }
};

/**
 * Wrapped batch object
 */
class Batch : public Object<CassBatch, cass_batch_free> {
public:
  /**
   * Create the batch object based on the type of batch statement to use
   *
   * @param batch_type Type of batch to create (default: Unlogged)
   */
  Batch(CassBatchType batch_type = CASS_BATCH_TYPE_UNLOGGED)
      : Object<CassBatch, cass_batch_free>(cass_batch_new(batch_type)) {}

  /**
   * Create the batch object from the native driver batch object
   *
   * @param batch Native driver object
   */
  Batch(CassBatch* batch)
      : Object<CassBatch, cass_batch_free>(batch) {}

  /**
   * Create the batch object from the shared reference
   *
   * @param batch Shared reference
   */
  Batch(Ptr batch)
      : Object<CassBatch, cass_batch_free>(batch) {}

  /**
   * Add a statement (query or bound) to the batch
   *
   * @param statement Query or bound statement to add
   * @param assert_ok True if error code for future should be asserted
   *                  CASS_OK; false otherwise (default: true)
   */
  void add(Statement statement, bool assert_ok = true) {
    CassError error_code = cass_batch_add_statement(get(), statement.get());
    if (assert_ok) {
      ASSERT_EQ(CASS_OK, error_code)
          << "Unable to Add Statement to Batch: " << cass_error_desc(error_code);
    }
  }

  /**
   * Assign/Set the batch's consistency level
   *
   * @param consistency Consistency to use for the batch
   */
  void set_consistency(CassConsistency consistency) {
    ASSERT_EQ(CASS_OK, cass_batch_set_consistency(get(), consistency));
  }

  /**
   * Set the execution profile to execute the batch statement with
   *
   * @param name Execution profile to assign during execution of batch statement
   */
  void set_execution_profile(const std::string& name) {
    ASSERT_EQ(CASS_OK, cass_batch_set_execution_profile(get(), name.c_str()));
  }

  /**
   * Enable/Disable whether the statements in a batch are idempotent. Idempotent
   * batches are able to be automatically retried after timeouts/errors and can
   * be speculatively executed.
   *
   * @param enable True if statement in a batch is idempotent; false otherwise
   */
  void set_idempotent(bool enable) {
    ASSERT_EQ(CASS_OK, cass_batch_set_is_idempotent(get(), enable ? cass_true : cass_false));
  }

  /**
   * Assign/Set the timeout for batch execution
   *
   * @param timeout_ms Timeout in milliseconds
   */
  void set_request_timeout(uint64_t timeout_ms) {
    ASSERT_EQ(CASS_OK, cass_batch_set_request_timeout(get(), timeout_ms));
  }

  /**
   * Assign/Set the batch's retry policy
   *
   * @param retry_policy Retry policy to use for the batch
   */
  void set_retry_policy(RetryPolicy retry_policy) {
    ASSERT_EQ(CASS_OK, cass_batch_set_retry_policy(get(), retry_policy.get()));
  }

  /**
   * Assign/Set the batch's serial consistency level
   *
   * @param serial_consistency Serial consistency to use for the batch
   */
  void set_serial_consistency(CassConsistency serial_consistency) {
    ASSERT_EQ(CASS_OK, cass_batch_set_serial_consistency(get(), serial_consistency));
  }

  /**
   * Sets the batch's keyspace
   *
   * @param keyspace Keyspace to use when executing the batch
   */
  void set_keyspace(const std::string& keyspace) {
    ASSERT_EQ(CASS_OK, cass_batch_set_keyspace(get(), keyspace.c_str()));
  }

  /**
   * Sets the batch statement's timestamp
   *
   * @param timestamp Timestamp (in milliseconds) to apply to the batch statement
   */
  void set_timestamp(int64_t timestamp_ms) {
    ASSERT_EQ(CASS_OK, cass_batch_set_timestamp(get(), timestamp_ms));
  }
};

}} // namespace test::driver

#endif // __TEST_STATEMENT_HPP__