Skip to content

docs: Move continueWaitTimeout to OrchestratorOptions #6426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igorlukanin merged 1 commit into from
Apr 13, 2023
Merged

docs: Move continueWaitTimeout to OrchestratorOptions #6426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/content/Reference/Configuration/Config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ interface CubejsConfiguration {
}

interface OrchestratorOptions {
continueWaitTimeout: number;
redisPrefix: string;
rollupOnlyMode: boolean;
queryCacheOptions: {
refreshKeyRenewalThreshold: number;
backgroundRenew: boolean;
Expand All @@ -87,7 +89,6 @@ interface OrchestratorOptions {

interface QueueOptions {
concurrency: number;
continueWaitTimeout: number;
executionTimeout: number;
orphanedTimeout: number;
heartBeatInterval: number;
Expand Down Expand Up @@ -690,6 +691,7 @@ You can pass this object to set advanced options for Cube Query Orchestrator.

| Option | Description | Default Value |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| continueWaitTimeout | Long polling interval | `5` |
| redisPrefix | Prefix to be set an all Redis keys | `STANDALONE` |
| rollupOnlyMode | When enabled, an error will be thrown if a query can't be served from a pre-aggregation (rollup) | `false` |
| queryCacheOptions | Query cache options for DB queries | `{}` |
Expand Down Expand Up @@ -773,7 +775,6 @@ Timeout and interval options' values are in seconds.
| Option | Description | Default Value |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| concurrency | Maximum number of queries to be processed simultaneosly. For drivers with connection pool `CUBEJS_DB_MAX_POOL` should be adjusted accordingly. Typically pool size should be at least twice of total concurrency among all queues. | `2` |
| continueWaitTimeout | Long polling interval | `5` |
| executionTimeout | Total timeout of single query | `600` |
| orphanedTimeout | Query will be marked for cancellation if not requested during this period. | `120` |
| heartBeatInterval | Worker heartbeat interval. If `4*heartBeatInterval` time passes without reporting, the query gets cancelled. | `30` |
Expand Down