Package com.activeviam.database.api

Interface IDatabaseSettings

public interface IDatabaseSettings

Common settings for connecting to a database via DirectQuery.

Default values are:

• maxSubQueriesAllowedInMultiStepQuery(): DEFAULT_MAX_SUB_QUERIES_ALLOWED_IN_MULTI_STEP_QUERY
• getByKeyBehavior(): DEFAULT_GET_BY_KEY_QUERY_BEHAVIOR
• useClusteringFields(): DEFAULT_USE_CLUSTERING_FIELDS
• feedingQueryTimeout(): DEFAULT_FEEDING_QUERY_TIMEOUT_LIMIT

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IDatabaseSettings.GetByKeyBehavior
static enum	IDatabaseSettings.UseClusteringFields

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_FEEDING_QUERY_TIMEOUT_LIMIT
static final IDatabaseSettings.GetByKeyBehavior	DEFAULT_GET_BY_KEY_QUERY_BEHAVIOR
static final int	DEFAULT_MAX_SUB_QUERIES_ALLOWED_IN_MULTI_STEP_QUERY
static final IDatabaseSettings.UseClusteringFields	DEFAULT_USE_CLUSTERING_FIELDS

Method Summary

Modifier and Type	Method	Description
Duration	feedingQueryTimeout()	Timeout (in seconds) which can be set on a query running on the external database during the feeding.
IDatabaseSettings.GetByKeyBehavior	getByKeyBehavior()	While Get-by-key queries performed on the datastore are very fast, they can take a long time on external databases, solely due to the networking time.
int	maxSubQueriesAllowedInMultiStepQuery()	A query clustered by too many fields or by fields with a high cardinality can be divided in lots of sub queries.
IDatabaseSettings.UseClusteringFields	useClusteringFields()	Returns whether clustering fields should be used for all queries or only for feeding queries.

Field Details

DEFAULT_MAX_SUB_QUERIES_ALLOWED_IN_MULTI_STEP_QUERY

static final int DEFAULT_MAX_SUB_QUERIES_ALLOWED_IN_MULTI_STEP_QUERY

See Also:

• Constant Field Values

DEFAULT_GET_BY_KEY_QUERY_BEHAVIOR

static final IDatabaseSettings.GetByKeyBehavior DEFAULT_GET_BY_KEY_QUERY_BEHAVIOR

DEFAULT_USE_CLUSTERING_FIELDS

static final IDatabaseSettings.UseClusteringFields DEFAULT_USE_CLUSTERING_FIELDS

DEFAULT_FEEDING_QUERY_TIMEOUT_LIMIT

static final Duration DEFAULT_FEEDING_QUERY_TIMEOUT_LIMIT

Method Details

maxSubQueriesAllowedInMultiStepQuery

int maxSubQueriesAllowedInMultiStepQuery()

A query clustered by too many fields or by fields with a high cardinality can be divided in lots of sub queries. To avoid creating too many queries on the external database, a limit is set on the number of those sub queries. This property sets the limit.

It is recommended to be conservative when increasing the limit. See documentation for more details.

Defaults to 500.

getByKeyBehavior

IDatabaseSettings.GetByKeyBehavior getByKeyBehavior()

While Get-by-key queries performed on the datastore are very fast, they can take a long time on external databases, solely due to the networking time. When performing a Get-by-key query through DirectQuery, the possible behaviors are denying, warning, or allowing the query to run.

Defaults to DEFAULT_GET_BY_KEY_QUERY_BEHAVIOR.

useClusteringFields

IDatabaseSettings.UseClusteringFields useClusteringFields()

Returns whether clustering fields should be used for all queries or only for feeding queries.

Defaults to DEFAULT_USE_CLUSTERING_FIELDS.

feedingQueryTimeout

Duration feedingQueryTimeout()

Timeout (in seconds) which can be set on a query running on the external database during the feeding.

Feeding queries are the ones run during the initial loading to feed the aggregate providers and hierarchies, and also during the refresh operations.

It defaults to 1 hour and cannot be less than a second.

This limit is only for external databases and does not impact queries on datastore.

Warning: increasing this value might result in longer queries and higher costs.