couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/management/analytics_link.hxx

@@ -24,216 +24,220 @@ namespace couchbase::management
 {
 
 enum analytics_link_type {
-    /**
-     * S3 external analytics link. Corresponds to a @ref s3_external_analytics_link
-     */
-    s3_external,
-
-    /**
-     * Azure external analytics link. Corresponds to a @ref azure_blob_external_analytics_link
-     */
-    azure_external,
-
-    /**
-     * A remote analytics link that uses a Couchbase data service that is not part of the same cluster as the Analytics service.
-     * Corresponds to a @ref couchbase_remote_analytics_link
-     */
-    couchbase_remote,
+  /**
+   * S3 external analytics link. Corresponds to a @ref s3_external_analytics_link
+   */
+  s3_external,
+
+  /**
+   * Azure external analytics link. Corresponds to a @ref azure_blob_external_analytics_link
+   */
+  azure_external,
+
+  /**
+   * A remote analytics link that uses a Couchbase data service that is not part of the same cluster
+   * as the Analytics service. Corresponds to a @ref couchbase_remote_analytics_link
+   */
+  couchbase_remote,
 };
 
 enum analytics_encryption_level {
-    /**
-     * Connect to the remote Couchbase cluster using an unsecured channel. Send the password in plaintext.
-     */
-    none,
-
-    /**
-     * Connect to the remote Couchbase cluster using an unsecured channel. Send the password securely using SASL.
-     */
-    half,
-
-    /**
-     * Connect to the remote Couchbase cluster using a channel secured by TLS. If a password is used, it is sent over the secure channel.
-     *
-     * Requires specifying the certificate to trust.
-     */
-    full
+  /**
+   * Connect to the remote Couchbase cluster using an unsecured channel. Send the password in
+   * plaintext.
+   */
+  none,
+
+  /**
+   * Connect to the remote Couchbase cluster using an unsecured channel. Send the password securely
+   * using SASL.
+   */
+  half,
+
+  /**
+   * Connect to the remote Couchbase cluster using a channel secured by TLS. If a password is used,
+   * it is sent over the secure channel.
+   *
+   * Requires specifying the certificate to trust.
+   */
+  full
 };
 
 struct analytics_link {
-    std::string name;
-    std::string dataverse_name;
+  std::string name;
+  std::string dataverse_name;
 
-    virtual ~analytics_link() = default;
+  virtual ~analytics_link() = default;
 
-    /**
-     * Returns the type of this analytics link
-     *
-     * @return the link type
-     */
-    [[nodiscard]] virtual analytics_link_type link_type() const = 0;
+  /**
+   * Returns the type of this analytics link
+   *
+   * @return the link type
+   */
+  [[nodiscard]] virtual auto link_type() const -> analytics_link_type = 0;
 
-    analytics_link() = default;
-    analytics_link(std::string name, std::string dataverse_name);
+  analytics_link() = default;
+  analytics_link(std::string name, std::string dataverse_name);
 };
 
 struct couchbase_analytics_encryption_settings {
-    /**
-     * Specifies what level of encryption should be applied
-     */
-    analytics_encryption_level encryption_level{ analytics_encryption_level::none };
-
-    /**
-     * The certificate to use for encryption when the encryption level is set to 'full'.
-     */
-    std::optional<std::string> certificate{};
-
-    /**
-     * The certificate to use for authenticating when the encryption level is set to 'full'. Cannot be set if a username and password are
-     * provided
-     */
-    std::optional<std::string> client_certificate{};
-
-    /**
-     * The client key to use for authenticating when the encryption level is set to 'full'.  Cannot be set if a username and password are
-     * provided
-     */
-    std::optional<std::string> client_key{};
+  /**
+   * Specifies what level of encryption should be applied
+   */
+  analytics_encryption_level encryption_level{ analytics_encryption_level::none };
+
+  /**
+   * The certificate to use for encryption when the encryption level is set to 'full'.
+   */
+  std::optional<std::string> certificate{};
+
+  /**
+   * The certificate to use for authenticating when the encryption level is set to 'full'. Cannot be
+   * set if a username and password are provided
+   */
+  std::optional<std::string> client_certificate{};
+
+  /**
+   * The client key to use for authenticating when the encryption level is set to 'full'.  Cannot be
+   * set if a username and password are provided
+   */
+  std::optional<std::string> client_key{};
 };
 
 struct couchbase_remote_analytics_link : analytics_link {
-    std::string hostname;
-    couchbase_analytics_encryption_settings encryption{};
-    std::optional<std::string> username{};
-    std::optional<std::string> password{};
-
-    [[nodiscard]] analytics_link_type link_type() const override
-    {
-        return analytics_link_type::couchbase_remote;
-    }
-
-    /**
-     * Constructs an empty remote Couchbase analytics link.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    couchbase_remote_analytics_link() = default;
-
-    /**
-     * Constructs and initializes a remote Couchbase analytics link with the given parameters. A remote analytics link uses a Couchbase data
-     * service that is not part of the same cluster as the Analytics service.
-     *
-     * @param name the name of the link
-     * @param dataverse_name the dataverse that the link belongs to. Its format can be one part `dataversename` or two parts
-     * `bucket_name/scope_name`
-     * @param hostname the hostname of the target Couchbase cluster
-     * @param encryption the encryption settings for the link
-     * @param username the username to use for authentication with the remote cluster. Optional if client certificate authentication is
-     * being used
-     * @param password the password to use for authentication with the remote cluster. Optional if client-certificate authentication is
-     * being used
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    couchbase_remote_analytics_link(std::string name,
-                                    std::string dataverse_name,
-                                    std::string hostname,
-                                    couchbase_analytics_encryption_settings encryption = {},
-                                    std::optional<std::string> username = {},
-                                    std::optional<std::string> password = {});
+  std::string hostname;
+  couchbase_analytics_encryption_settings encryption{};
+  std::optional<std::string> username{};
+  std::optional<std::string> password{};
+
+  [[nodiscard]] auto link_type() const -> analytics_link_type override
+  {
+    return analytics_link_type::couchbase_remote;
+  }
+
+  /**
+   * Constructs an empty remote Couchbase analytics link.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  couchbase_remote_analytics_link() = default;
+
+  /**
+   * Constructs and initializes a remote Couchbase analytics link with the given parameters. A
+   * remote analytics link uses a Couchbase data service that is not part of the same cluster as the
+   * Analytics service.
+   *
+   * @param name the name of the link
+   * @param dataverse_name the dataverse that the link belongs to. Its format can be one part
+   * `dataversename` or two parts `bucket_name/scope_name`
+   * @param hostname the hostname of the target Couchbase cluster
+   * @param encryption the encryption settings for the link
+   * @param username the username to use for authentication with the remote cluster. Optional if
+   * client certificate authentication is being used
+   * @param password the password to use for authentication with the remote cluster. Optional if
+   * client-certificate authentication is being used
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  couchbase_remote_analytics_link(std::string name,
+                                  std::string dataverse_name,
+                                  std::string hostname,
+                                  couchbase_analytics_encryption_settings encryption = {},
+                                  std::optional<std::string> username = {},
+                                  std::optional<std::string> password = {});
 };
 
 struct s3_external_analytics_link : analytics_link {
-    std::string access_key_id;
-    std::string secret_access_key;
-    std::string region;
-    std::optional<std::string> session_token{};
-    std::optional<std::string> service_endpoint{};
-
-    [[nodiscard]] analytics_link_type link_type() const override
-    {
-        return analytics_link_type::s3_external;
-    }
-
-    /**
-     * Constructs an empty external S3 analytics link
-     *
-     * @committed
-     * @since 1.0.0
-     */
-    s3_external_analytics_link() = default;
-
-    /**
-     * Constructs and initializes an external S3 analytics link with the given parameters.
-     *
-     * @param name the name of the link
-     * @param dataverse_name the name of the dataverse the link belongs to
-     * @param access_key_id the AWS S3 access key
-     * @param secret_access_key the AWS S3 secret key
-     * @param region the AWS S3 region
-     * @param session_token the AWS S3 token if temporary credentials are provided
-     * @param service_endpoint the AWS S3 service endpoint
-     *
-     * @committed
-     * @since 1.0.0
-     */
-    s3_external_analytics_link(std::string name,
-                               std::string dataverse_name,
-                               std::string access_key_id,
-                               std::string secret_access_key,
-                               std::string region,
-                               std::optional<std::string> session_token = {},
-                               std::optional<std::string> service_endpoint = {});
+  std::string access_key_id;
+  std::string secret_access_key;
+  std::string region;
+  std::optional<std::string> session_token{};
+  std::optional<std::string> service_endpoint{};
+
+  [[nodiscard]] auto link_type() const -> analytics_link_type override
+  {
+    return analytics_link_type::s3_external;
+  }
+
+  /**
+   * Constructs an empty external S3 analytics link
+   *
+   * @committed
+   * @since 1.0.0
+   */
+  s3_external_analytics_link() = default;
+
+  /**
+   * Constructs and initializes an external S3 analytics link with the given parameters.
+   *
+   * @param name the name of the link
+   * @param dataverse_name the name of the dataverse the link belongs to
+   * @param access_key_id the AWS S3 access key
+   * @param secret_access_key the AWS S3 secret key
+   * @param region the AWS S3 region
+   * @param session_token the AWS S3 token if temporary credentials are provided
+   * @param service_endpoint the AWS S3 service endpoint
+   *
+   * @committed
+   * @since 1.0.0
+   */
+  s3_external_analytics_link(std::string name,
+                             std::string dataverse_name,
+                             std::string access_key_id,
+                             std::string secret_access_key,
+                             std::string region,
+                             std::optional<std::string> session_token = {},
+                             std::optional<std::string> service_endpoint = {});
 };
 
 struct azure_blob_external_analytics_link : analytics_link {
-    std::optional<std::string> connection_string{};
-    std::optional<std::string> account_name{};
-    std::optional<std::string> account_key{};
-    std::optional<std::string> shared_access_signature{};
-    std::optional<std::string> blob_endpoint{};
-    std::optional<std::string> endpoint_suffix{};
-
-    [[nodiscard]] analytics_link_type link_type() const override
-    {
-        return analytics_link_type::azure_external;
-    }
-
-    /**
-     * Constructs an empty external Azure blob analytics link.
-     *
-     * @committed
-     * @since 1.0.0
-     */
-    azure_blob_external_analytics_link() = default;
-
-    /**
-     * Constructs and initializes an external Azure blob analytics link.
-     *
-     * @param name the name of the link
-     * @param dataverse_name the name of the dataverse the link belongs to
-     * @param connection_string the connection string that can be used as an authentication method. It contains other authentication methods
-     * embedded inside the string. Only a single authentication method can be used (e.g.
-     * "AccountName=myAccountName;AccountKey=myAccountKey").
-     * @param account_name the Azure blob storage account name
-     * @param account_key the Azure blob storage account key
-     * @param shared_access_signature token that can be used for authentication
-     * @param blob_endpoint the Azure blob storage endpoint
-     * @param endpoint_suffix the Azure blob endpoint suffix
-     *
-     * @committed
-     * @since 1.0.0
-     */
-    azure_blob_external_analytics_link(std::string name,
-                                       std::string dataverse_name,
-                                       std::optional<std::string> connection_string = {},
-                                       std::optional<std::string> account_name = {},
-                                       std::optional<std::string> account_key = {},
-                                       std::optional<std::string> shared_access_signature = {},
-                                       std::optional<std::string> blob_endpoint = {},
-                                       std::optional<std::string> endpoint_suffix = {});
+  std::optional<std::string> connection_string{};
+  std::optional<std::string> account_name{};
+  std::optional<std::string> account_key{};
+  std::optional<std::string> shared_access_signature{};
+  std::optional<std::string> blob_endpoint{};
+  std::optional<std::string> endpoint_suffix{};
+
+  [[nodiscard]] auto link_type() const -> analytics_link_type override
+  {
+    return analytics_link_type::azure_external;
+  }
+
+  /**
+   * Constructs an empty external Azure blob analytics link.
+   *
+   * @committed
+   * @since 1.0.0
+   */
+  azure_blob_external_analytics_link() = default;
+
+  /**
+   * Constructs and initializes an external Azure blob analytics link.
+   *
+   * @param name the name of the link
+   * @param dataverse_name the name of the dataverse the link belongs to
+   * @param connection_string the connection string that can be used as an authentication method. It
+   * contains other authentication methods embedded inside the string. Only a single authentication
+   * method can be used (e.g. "AccountName=myAccountName;AccountKey=myAccountKey").
+   * @param account_name the Azure blob storage account name
+   * @param account_key the Azure blob storage account key
+   * @param shared_access_signature token that can be used for authentication
+   * @param blob_endpoint the Azure blob storage endpoint
+   * @param endpoint_suffix the Azure blob endpoint suffix
+   *
+   * @committed
+   * @since 1.0.0
+   */
+  azure_blob_external_analytics_link(std::string name,
+                                     std::string dataverse_name,
+                                     std::optional<std::string> connection_string = {},
+                                     std::optional<std::string> account_name = {},
+                                     std::optional<std::string> account_key = {},
+                                     std::optional<std::string> shared_access_signature = {},
+                                     std::optional<std::string> blob_endpoint = {},
+                                     std::optional<std::string> endpoint_suffix = {});
 };
 
 } // namespace couchbase::management

data/ext/couchbase/couchbase/management/bucket_settings.hxx

@@ -26,94 +26,110 @@
 
 namespace couchbase::management::cluster
 {
-enum class bucket_type { unknown, couchbase, memcached, ephemeral };
-enum class bucket_compression { unknown, off, active, passive };
+enum class bucket_type {
+  unknown,
+  couchbase,
+  memcached,
+  ephemeral
+};
+enum class bucket_compression {
+  unknown,
+  off,
+  active,
+  passive
+};
 enum class bucket_eviction_policy {
-    unknown,
+  unknown,
 
-    /**
-     * During ejection, everything (including key, metadata, and value) will be ejected.
-     *
-     * Full Ejection reduces the memory overhead requirement, at the cost of performance.
-     *
-     * This value is only valid for buckets of type COUCHBASE.
-     */
-    full,
+  /**
+   * During ejection, everything (including key, metadata, and value) will be ejected.
+   *
+   * Full Ejection reduces the memory overhead requirement, at the cost of performance.
+   *
+   * This value is only valid for buckets of type COUCHBASE.
+   */
+  full,
 
-    /**
-     * During ejection, only the value will be ejected (key and metadata will remain in memory).
-     *
-     * Value Ejection needs more system memory, but provides better performance than Full Ejection.
-     *
-     * This value is only valid for buckets of type COUCHBASE.
-     */
-    value_only,
+  /**
+   * During ejection, only the value will be ejected (key and metadata will remain in memory).
+   *
+   * Value Ejection needs more system memory, but provides better performance than Full Ejection.
+   *
+   * This value is only valid for buckets of type COUCHBASE.
+   */
+  value_only,
 
-    /**
-     * Couchbase Server keeps all data until explicitly deleted, but will reject
-     * any new data if you reach the quota (dedicated memory) you set for your bucket.
-     *
-     * This value is only valid for buckets of type EPHEMERAL.
-     */
-    no_eviction,
+  /**
+   * Couchbase Server keeps all data until explicitly deleted, but will reject
+   * any new data if you reach the quota (dedicated memory) you set for your bucket.
+   *
+   * This value is only valid for buckets of type EPHEMERAL.
+   */
+  no_eviction,
 
-    /**
-     * When the memory quota is reached, Couchbase Server ejects data that has not been used recently.
-     *
-     * This value is only valid for buckets of type EPHEMERAL.
-     */
-    not_recently_used,
+  /**
+   * When the memory quota is reached, Couchbase Server ejects data that has not been used recently.
+   *
+   * This value is only valid for buckets of type EPHEMERAL.
+   */
+  not_recently_used,
 };
 enum class bucket_conflict_resolution {
-    unknown,
-    /**
-     * Use timestamp conflict resolution.
-     *
-     * Timestamp-based conflict resolution (often referred to as Last Write Wins, or LWW) uses the document
-     * timestamp (stored in the CAS) to resolve conflicts. The timestamps associated with the most recent
-     * updates of source and target documents are compared. The document whose update has the more recent
-     * timestamp prevails.
-     */
-    timestamp,
+  unknown,
+  /**
+   * Use timestamp conflict resolution.
+   *
+   * Timestamp-based conflict resolution (often referred to as Last Write Wins, or LWW) uses the
+   * document timestamp (stored in the CAS) to resolve conflicts. The timestamps associated with the
+   * most recent updates of source and target documents are compared. The document whose update has
+   * the more recent timestamp prevails.
+   */
+  timestamp,
 
-    /**
-     * Use sequence number conflict resolution
-     *
-     * Conflicts can be resolved by referring to documents' sequence numbers. Sequence numbers are maintained
-     * per document, and are incremented on every document-update. The sequence numbers of source and
-     * target documents are compared; and the document with the higher sequence number prevails.
-     */
-    sequence_number,
+  /**
+   * Use sequence number conflict resolution
+   *
+   * Conflicts can be resolved by referring to documents' sequence numbers. Sequence numbers are
+   * maintained per document, and are incremented on every document-update. The sequence numbers of
+   * source and target documents are compared; and the document with the higher sequence number
+   * prevails.
+   */
+  sequence_number,
 
-    /**
-     * VOLATILE: This API is subject to change at any time.
-     *
-     * In Couchbase Server 7.1, this feature is only available in "developer-preview" mode. See the UI XDCR settings.
-     */
-    custom,
+  /**
+   * VOLATILE: This API is subject to change at any time.
+   *
+   * In Couchbase Server 7.1, this feature is only available in "developer-preview" mode. See the UI
+   * XDCR settings.
+   */
+  custom,
+};
+enum class bucket_storage_backend {
+  unknown,
+  couchstore,
+  magma
 };
-enum class bucket_storage_backend { unknown, couchstore, magma };
 
 struct bucket_settings {
 
-    std::string name;
-    cluster::bucket_type bucket_type{ cluster::bucket_type::unknown };
-    std::uint64_t ram_quota_mb{ 0 };
-    std::optional<std::uint32_t> max_expiry{};
-    bucket_compression compression_mode{ bucket_compression::unknown };
-    std::optional<couchbase::durability_level> minimum_durability_level{};
-    std::optional<std::uint32_t> num_replicas{};
-    std::optional<bool> replica_indexes{};
-    std::optional<bool> flush_enabled{};
-    bucket_eviction_policy eviction_policy{ bucket_eviction_policy::unknown };
-    bucket_conflict_resolution conflict_resolution_type{ bucket_conflict_resolution::unknown };
-    std::optional<bool> history_retention_collection_default{};
-    std::optional<std::uint32_t> history_retention_bytes;
-    std::optional<std::uint32_t> history_retention_duration{};
+  std::string name;
+  cluster::bucket_type bucket_type{ cluster::bucket_type::unknown };
+  std::uint64_t ram_quota_mb{ 0 };
+  std::optional<std::uint32_t> max_expiry{};
+  bucket_compression compression_mode{ bucket_compression::unknown };
+  std::optional<couchbase::durability_level> minimum_durability_level{};
+  std::optional<std::uint32_t> num_replicas{};
+  std::optional<bool> replica_indexes{};
+  std::optional<bool> flush_enabled{};
+  bucket_eviction_policy eviction_policy{ bucket_eviction_policy::unknown };
+  bucket_conflict_resolution conflict_resolution_type{ bucket_conflict_resolution::unknown };
+  std::optional<bool> history_retention_collection_default{};
+  std::optional<std::uint32_t> history_retention_bytes;
+  std::optional<std::uint32_t> history_retention_duration{};
 
-    /**
-     * UNCOMMITTED: This API may change in the future
-     */
-    bucket_storage_backend storage_backend{ bucket_storage_backend::unknown };
+  /**
+   * UNCOMMITTED: This API may change in the future
+   */
+  bucket_storage_backend storage_backend{ bucket_storage_backend::unknown };
 };
 } // namespace couchbase::management::cluster

data/ext/couchbase/couchbase/management/collection_spec.hxx

@@ -20,10 +20,10 @@
 namespace couchbase::management::bucket
 {
 struct collection_spec {
-    std::string name;
-    std::string scope_name;
-    std::int32_t max_expiry{};
-    std::optional<bool> history{};
+  std::string name;
+  std::string scope_name;
+  std::int32_t max_expiry{};
+  std::optional<bool> history{};
 };
 
 } // namespace couchbase::management::bucket

data/ext/couchbase/couchbase/management/query_index.hxx

@@ -24,16 +24,16 @@
 namespace couchbase::management
 {
 struct query_index {
-    bool is_primary{ false };
-    std::string name;
-    std::string state;
-    std::string type;
-    std::vector<std::string> index_key{};
-    std::optional<std::string> partition{};
-    std::optional<std::string> condition{};
-    std::string bucket_name;
-    std::optional<std::string> scope_name{};
-    std::optional<std::string> collection_name{};
+  bool is_primary{ false };
+  std::string name;
+  std::string state;
+  std::string type;
+  std::vector<std::string> index_key{};
+  std::optional<std::string> partition{};
+  std::optional<std::string> condition{};
+  std::string bucket_name;
+  std::optional<std::string> scope_name{};
+  std::optional<std::string> collection_name{};
 };
 
 } // namespace couchbase::management

data/ext/couchbase/couchbase/management/scope_spec.hxx

@@ -22,8 +22,8 @@
 namespace couchbase::management::bucket
 {
 struct scope_spec {
-    std::string name;
-    std::vector<collection_spec> collections;
+  std::string name;
+  std::vector<collection_spec> collections;
 };
 
 } // namespace couchbase::management::bucket