akka local services components entities force-snapshot

Create a state snapshot of a single entity instance now.

Synopsis

The akka local service components entities force-snapshot command creates a state snapshot of a single entity instance now, without waiting for the configured number of events. Use it after a state schema change, to store the current state in the new format. The command is rejected when snapshots are disabled for the component. It does nothing, and reports success, for an instance that has no events yet or that has been deleted.

A snapshot change applies only in the region it is sent to. In a project with more than one region, pass --all-regions to run in every region, or --region REGION to run in one. A single-region project needs neither.

Creating a snapshot cancels a pending time-to-live on an event sourced entity. The entity is then never deleted by TTL until it is written to again with one. The command asks you to confirm this before it runs.

akka local services components entities force-snapshot SERVICE_NAME COMPONENT_ID ENTITY_ID [flags]

Options

      --all-regions      run the command in every region of the project
  -f, --force            Skip the confirmation prompt.
  -h, --help             help for force-snapshot
      --owner string     the owner of the project to use, needed if you have two projects with the same name from different owners
      --project string   project to use if not using the default configured project
      --region string    region to use if project has more than one region

Options inherited from parent commands

      --cache-file string   location of cache file (default "~/.akka/cache.yaml")
      --config string       location of config file (default "~/.akka/config.yaml")
      --context string      configuration context to use
      --disable-prompt      Disable all interactive prompts when running akka commands. If input is required, defaults will be used, or an error will be raised.
                            This is equivalent to setting the environment variable AKKA_DISABLE_PROMPTS to true.
  -o, --output string       set output format to one of [text,json,json-compact,go-template=] (default "text")
      --page-mode string    the mode for paging, either paged, buffered or auto. (default "auto")
  -q, --quiet               set quiet output (helpful when used as part of a script)
      --timeout duration    client command timeout (default 10s)
      --use-grpc-web        use grpc-web when talking to Akka APIs. This is useful when behind corporate firewalls that decrypt traffic but don't support HTTP/2.
      --verbose             set verbose output

SEE ALSO