io.micronaut.data.cosmos.config.CosmosDatabaseConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-azure-cosmos Show documentation
Data Repository Support for Micronaut
The newest version!
/*
 * Copyright 2017-2022 original authors
 *
 * Licensed 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
 *
 * https://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.
 */
package io.micronaut.data.cosmos.config;

import io.micronaut.context.annotation.ConfigurationProperties;
import io.micronaut.context.annotation.EachProperty;
import io.micronaut.context.annotation.Parameter;
import io.micronaut.context.annotation.Primary;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import jakarta.inject.Inject;

import java.util.ArrayList;
import java.util.List;

import static io.micronaut.data.cosmos.config.CosmosDatabaseConfiguration.PREFIX;

/**
 * The Azure Cosmos database configuration.
 *
 * @author radovanradic
 * @since 3.9.0
 */
@ConfigurationProperties(PREFIX)
public final class CosmosDatabaseConfiguration {

    public static final String PREFIX = "azure.cosmos.database";

    private ThroughputSettings throughput;

    private List containers;

    private String databaseName;

    private StorageUpdatePolicy updatePolicy = StorageUpdatePolicy.NONE;

    private List packages = new ArrayList<>();

    private boolean queryMetricsEnabled = true;

    private boolean disableNonStreamingOrderBy = false;

    public ThroughputSettings getThroughput() {
        return throughput;
    }

    @Inject
    public void setThroughput(ThroughputSettings throughput) {
        this.throughput = throughput;
    }

    public List getContainers() {
        return containers;
    }

    @Inject
    public void setContainers(List containers) {
        this.containers = containers;
    }

    /**
     * @return the database name
     */
    @NonNull
    public String getDatabaseName() {
        return databaseName;
    }

    /**
     * Sets the database name.
     *
     * @param databaseName the database name
     */
    public void setDatabaseName(String databaseName) {
        this.databaseName = databaseName;
    }

    /**
     * @return the update policy for the database to be used during startup.
     */
    public StorageUpdatePolicy getUpdatePolicy() {
        return updatePolicy;
    }

    /**
     * Sets the update policy for the database to be used during startup.
     *
     * @param updatePolicy the update policy for the database
     */
    public void setUpdatePolicy(StorageUpdatePolicy updatePolicy) {
        this.updatePolicy = updatePolicy;
    }

    /**
     * @return the list of package names to filter entities during init database and containers
     */
    public List getPackages() {
        return packages;
    }

    /**
     * @param packages the package names to be considered during init
     */
    public void setPackages(List packages) {
        this.packages = packages;
    }

    /**
     * Gets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests.
     * If this is turned off then detailed query metrics information will not be retrieved in the Cosmos Diagnostics query response.
     * The default value is true.
     *
     * @return the query metrics enabled indicator
     */
    public boolean isQueryMetricsEnabled() {
        return queryMetricsEnabled;
    }

    /**
     * Sets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests.
     *
     * @param queryMetricsEnabled the query metrics enabled indicator
     */
    public void setQueryMetricsEnabled(boolean queryMetricsEnabled) {
        this.queryMetricsEnabled = queryMetricsEnabled;
    }

    /**
     * Gets an indicator telling whether non-streaming order by is by default disabled.
     * By default, it is not disabled currently and users can change it as needed.
     * Effectively, this value will be set as "COSMOS.AZURE_COSMOS_DISABLE_NON_STREAMING_ORDER_BY" env variable.
     *
     * @return the disabled non-streaming order by indicator
     */
    public boolean isDisableNonStreamingOrderBy() {
        return disableNonStreamingOrderBy;
    }

    /**
     * Sets an indicator telling whether non-streaming order by is by default disabled.
     *
     * @param disableNonStreamingOrderBy the disabled non-streaming order by indicator
     */
    public void setDisableNonStreamingOrderBy(boolean disableNonStreamingOrderBy) {
        this.disableNonStreamingOrderBy = disableNonStreamingOrderBy;
    }

    /**
     * Throughput settings for database.
     */
    @ConfigurationProperties("throughput-settings")
    @Primary
    public static final class DefaultThroughputSettings extends ThroughputSettings {
    }

    /**
     * The settings for Cosmos container.
     */
    @EachProperty(value = "container-settings", list = true)
    public static class CosmosContainerSettings {

        private String containerName;

        private String partitionKeyPath;

        private ThroughputSettings throughput;

        public CosmosContainerSettings(@Parameter @Nullable ContainerThroughputSettings throughput) {
            this.throughput = throughput;
        }

        /**
         * @return the container name
         */
        public String getContainerName() {
            return containerName;
        }

        /**
         * Sets the container name.
         *
         * @param containerName the container name
         */
        public void setContainerName(String containerName) {
            this.containerName = containerName;
        }

        /**
         * @return the partition key path for the container
         */
        public String getPartitionKeyPath() {
            return partitionKeyPath;
        }

        /**
         * Sets the container partition key path.
         *
         * @param partitionKeyPath the partition key path
         */
        public void setPartitionKeyPath(String partitionKeyPath) {
            this.partitionKeyPath = partitionKeyPath;
        }

        /**
         * @return container throughput settings
         */
        public ThroughputSettings getThroughput() {
            return throughput;
        }

        /**
         * Sets the container throughput settings.
         *
         * @param throughput the throughput settings
         */
        public void setThroughput(ContainerThroughputSettings throughput) {
            this.throughput = throughput;
        }


        /**
         * Throughput settings for container.
         */
        @ConfigurationProperties("throughput-settings")
        public static final class ContainerThroughputSettings extends ThroughputSettings {
        }
    }
}