Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas dataFederation queryLimits create

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Creates a new Data Federation query limit.

To learn more about the query limits, see https://dochub.mongodb.org/core/adf-query-limits.To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas dataFederation queryLimits create <name> [options]
Name
Type
Required
Description

name

string

true

Identifier of the data federation query limit.

Name
Type
Required
Description

--dataFederation

string

true

Identifier of the Federated Database Instance.

-h, --help

false

help for create

-o, --output

string

false

Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.

--overrunPolicy

string

false

Action to take when the usage limit is exceeded.

--projectId

string

false

Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.

--value

int

true

Value given to the query limit.

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Data federation query limit <Name> created.
# create data federation query limit:
atlas dataFederation queryLimit create bytesProcessed.query --value 1000 --dataFederation DataFederation1

Back

queryLimits