Modal logo
Changelog API Reference modal.Appmodal.Clientmodal.CloudBucketMountmodal.Clsmodal.Cronmodal.Dictmodal.Environmentmodal.Errormodal.FilePatternMatchermodal.Functionmodal.FunctionCallmodal.Imagemodal.Periodmodal.Probemodal.Proxymodal.Queuemodal.Retriesmodal.Sandboxmodal.SandboxSnapshotmodal.Secretmodal.Tunnelmodal.Volumemodal.asgi_appmodal.batchedmodal.billingmodal.call_graphmodal.concurrentmodal.container_processmodal.current_function_call_idmodal.current_input_idmodal.enable_outputmodal.entermodal.exitmodal.fastapi_endpointmodal.file_iomodal.forwardmodal.interactmodal.io_streamsmodal.is_localmodal.methodmodal.parametermodal.web_servermodal.wsgi_appmodal.exceptionmodal.config CLI Reference modal appmodal billingmodal bootstrapmodal changelogmodal configmodal containermodal dashboardmodal deploymodal dictmodal environmentmodal profilemodal queuemodal runmodal secretmodal servemodal setupmodal shellmodal tokenmodal volume

modal queue

Manage modal.Queue objects and inspect their contents.

Usage:

modal queue [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • clear: Clear the contents of a queue by removing all of its data.
  • create: Create a named Queue.
  • delete: Delete a named Queue and all of its data.
  • len: Print the length of the queue or one of its partitions.
  • list: List all named Queues.
  • peek: Print the next N items without removing them.

Clear the contents of a queue by removing all of its data.

Usage:

modal queue clear [OPTIONS] NAME

Options:

  • -p, --partition TEXT: Name of the partition to use, otherwise use the default (anonymous) partition.
  • -a, --all: Clear the contents of all partitions.
  • -y, --yes: Run without pausing for confirmation.
  • -e, --env TEXT: Environment to interact with. If unspecified, defers to MODAL_ENVIRONMENT, your active local profile, or your workspace default, in that order.
  • --help: Show this message and exit.

Create a named Queue.

Note: This is a no-op when the Queue already exists.

Usage:

modal queue create [OPTIONS] NAME

Options:

  • -e, --env TEXT: Environment to interact with. If unspecified, defers to MODAL_ENVIRONMENT, your active local profile, or your workspace default, in that order.
  • --help: Show this message and exit.

Delete a named Queue and all of its data.

Usage:

modal queue delete [OPTIONS] NAME

Options:

  • --allow-missing: Don’t error if the Queue doesn’t exist.
  • -y, --yes: Run without pausing for confirmation.
  • -e, --env TEXT: Environment to interact with. If unspecified, defers to MODAL_ENVIRONMENT, your active local profile, or your workspace default, in that order.
  • --help: Show this message and exit.

Print the length of the queue or one of its partitions.

Usage:

modal queue len [OPTIONS] NAME

Options:

  • -p, --partition TEXT: Name of the partition to use, otherwise use the default (anonymous) partition.
  • -t, --total: Compute the sum of the queue lengths across all partitions
  • -e, --env TEXT: Environment to interact with. If unspecified, defers to MODAL_ENVIRONMENT, your active local profile, or your workspace default, in that order.
  • --help: Show this message and exit.

List all named Queues.

Usage:

modal queue list [OPTIONS]

Options:

  • --json
  • -e, --env TEXT: Environment to interact with. If unspecified, defers to MODAL_ENVIRONMENT, your active local profile, or your workspace default, in that order.
  • --help: Show this message and exit.

Print the next N items without removing them.

Usage:

modal queue peek [OPTIONS] NAME [N]

Options:

  • -p, --partition TEXT: Name of the partition to use, otherwise use the default (anonymous) partition.
  • -e, --env TEXT: Environment to interact with. If unspecified, defers to MODAL_ENVIRONMENT, your active local profile, or your workspace default, in that order.
  • --help: Show this message and exit.