Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Doc Store

Store and retrieve documents

sfp server doc-store add

Add a document to the doc store

USAGE
  $ sfp server doc-store add -k <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [-v <value> | -f <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               Path to JSON file containing the value
  -k, --key=<value>                (required) Key for the document
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -v, --value=<value>              Value for the document (must be valid JSON)
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Add a document to the doc store

EXAMPLES
  $ sfp server doc-store add --key myKey --value '{"data": "value"}' --email user@example.com

  $ sfp server doc-store add --key myKey --value '{"data": "value"}' --application-token myToken

  $ sfp server doc-store add --key myKey --file ./data.json --email user@example.com

See code: src/commands/server/doc-store/add.ts

sfp server doc-store collection add

Add a document to a collection in the doc store

USAGE
  $ sfp server doc-store collection add -c <value> (-k <value> | -d <value>) [--json] [--repository <value>] [-e <value>] [-t
    <value>] [--sfp-server-url <value>] [-v <value> | -f <value> | ] [--store <value>]

FLAGS
  -c, --collection=<value>         (required) Name of the collection
  -d, --folder=<value>             Path to folder to process recursively
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               Path to JSON file containing the value
  -k, --key=<value>                (required) Key for the document
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -v, --value=<value>              Value for the document (must be valid JSON)
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url
      --store=<value>              Target store for the document (e.g., builds, packages, changelog)

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Add a document to a collection in the doc store

EXAMPLES
  $ sfp server doc-store collection add --collection myCollection --key myKey --value '{"data": "value"}' --email user@example.com

  $ sfp server doc-store collection add --collection myCollection --key myKey --value '{"data": "value"}' --application-token myToken

  $ sfp server doc-store collection add --collection myCollection --key myKey --file ./data.json --email user@example.com

  $ sfp server doc-store collection add --collection myCollection --folder ./data --email user@example.com

See code: src/commands/server/doc-store/collection/add.ts

sfp server doc-store collection delete

Delete a document from a collection in the doc store

USAGE
  $ sfp server doc-store collection delete -c <value> [--json] [-k <value> | -m <value>] [-n <value>]

FLAGS
  -c, --collection=<value>  (required) Name of the collection
  -k, --key=<value>         Key of the document to delete
  -m, --keys=<value>        Comma-separated list of document keys to delete
  -n, --version=<value>     Version of the document to delete

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a document from a collection in the doc store

EXAMPLES
  $ sfp server doc-store collection delete --collection myCollection --key myKey --version 1 --email user@example.com

  $ sfp server doc-store collection delete --collection myCollection --key myKey --version 1 --application-token myToken

  $ sfp server doc-store collection delete --collection myCollection --keys key1,key2,key3 --version 1 --email user@example.com

See code: src/commands/server/doc-store/collection/delete.ts

sfp server doc-store collection get

Get documents from a collection in the doc store

USAGE
  $ sfp server doc-store collection get -c <value> [--json] [-k <value> | -o <value> | -f <value>...] [-s <value>...] [--limit
    <value>] [--offset <value>] [-e <value> | -t <value>] [--sfp-server-url <value>]

FLAGS
  -c, --collection=<value>         (required) Name of the collection
  -e, --email=<value>              Email used for authentication
  -f, --filter=<value>...          Filter documents using expressions like 'field=value', 'field>value', 'field~pattern'
  -k, --key=<value>                Key of the document to retrieve
  -o, --output-folder=<value>      Output folder path to recreate the collection structure
  -s, --sort=<value>...            Sort results by field:direction (e.g., 'createdAt:desc')
  -t, --application-token=<value>  Application token for authentication
      --limit=<value>              [default: 100] Maximum number of results to return (default: 100)
      --offset=<value>             Number of results to skip for pagination (default: 0)
      --sfp-server-url=<value>     [default: http://localhost:3029, env: SFP_SERVER_URL] URL of the SFP server

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get documents from a collection in the doc store

EXAMPLES
  $ sfp server doc-store collection get --collection myCollection --key myKey --email user@example.com

  $ sfp server doc-store collection get --collection myCollection --key myKey --application-token myToken

  $ sfp server doc-store collection get --collection myCollection --output-folder ./output --email user@example.com

  $ sfp server doc-store collection get --collection myCollection --output-folder ./output --application-token myToken



  # Filter by status

  $ sfp server doc-store collection get -c builds --filter "status=completed" --email user@example.com



  # Multiple filters with sorting

  $ sfp server doc-store collection get -c packages \

    --filter "status=active" \

    --filter "version>2.0" \

    --sort "createdAt:desc" \

    --limit 10 \

    --email user@example.com



  # Pattern matching

  $ sfp server doc-store collection get -c releases --filter "name~core" --email user@example.com



  # In operator for multiple values

  $ sfp server doc-store collection get -c deployments --filter "env in(dev,staging,prod)" --email user@example.com

See code: src/commands/server/doc-store/collection/get.ts

sfp server doc-store collection list

List all doc store collections on the server

USAGE
  $ sfp server doc-store collection list [--json] [-e <value> | -t <value>] [--sfp-server-url <value>]

FLAGS
  -e, --email=<value>              Email of the user
  -t, --application-token=<value>  Application token for authentication
      --sfp-server-url=<value>     [default: http://localhost:3029, env: SFP_SERVER_URL] URL of the sfp server

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all doc store collections on the server

EXAMPLES
  $ sfp server doc-store collection list --email user@example.com

  $ sfp server doc-store collection list --application-token myToken

  $ sfp server doc-store collection list --email user@example.com --json

See code: src/commands/server/doc-store/collection/list.ts

sfp server doc-store collection update

Update a document in a collection in the doc store

USAGE
  $ sfp server doc-store collection update -c <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [-k <value> | -d <value>] [-v <value> | -f <value> | ] [-n <value>] [-u]

FLAGS
  -c, --collection=<value>         (required) Name of the collection
  -d, --folder=<value>             Path to folder to process recursively
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               Path to JSON file containing the value
  -k, --key=<value>                Key of the document to update
  -n, --current-version=<value>    Version of the document to update
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -u, --upsert                     Create document if it does not exist, otherwise update it
  -v, --value=<value>              New value for the document (must be valid JSON)
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Update a document in a collection in the doc store

EXAMPLES
  $ sfp server doc-store collection update --collection myCollection --key myKey --value '{"data": "value"}' --current-version 1 --email user@example.com

  $ sfp server doc-store collection update --collection myCollection --key myKey --value '{"data": "value"}' --current-version 1 --application-token myToken

  $ sfp server doc-store collection update --collection myCollection --key myKey --file ./data.json --current-version 1 --email user@example.com

  $ sfp server doc-store collection update --collection myCollection --folder ./data --current-version 1 --email user@example.com

See code: src/commands/server/doc-store/collection/update.ts

sfp server doc-store delete

Delete a document from the doc store

USAGE
  $ sfp server doc-store delete -k <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [-n <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -k, --key=<value>                (required) Key of the document to delete
  -n, --version=<value>            Version of the document to delete
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete a document from the doc store

EXAMPLES
  $ sfp server doc-store delete --key myKey --email user@example.com

  $ sfp server doc-store delete --key myKey --application-token myToken

See code: src/commands/server/doc-store/delete.ts

sfp server doc-store get

Get a document from the doc store

USAGE
  $ sfp server doc-store get -k <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -k, --key=<value>                (required) Key of the document to retrieve
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get a document from the doc store

EXAMPLES
  $ sfp server doc-store get --key myKey --email user@example.com

  $ sfp server doc-store get --key myKey --application-token myToken

See code: src/commands/server/doc-store/get.ts

sfp server doc-store update

Update a document in the doc store

USAGE
  $ sfp server doc-store update -k <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [-v <value> | -f <value>] [-n <value>] [-u]

FLAGS
  -e, --email=<value>              Email address for authenticated user. Ignored if --application-token is provided. Can
                                   be set via SFP_SERVER_USER env var.
  -f, --file=<value>               Path to file to upload. JSON files will be parsed, other files will be base64 encoded
  -k, --key=<value>                (required) Key of the document to update
  -n, --current-version=<value>    Version of the document to update
  -t, --application-token=<value>  Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                   (CLI flags take precedence over env vars).
  -u, --upsert                     Create document if it does not exist, otherwise update it
  -v, --value=<value>              New value for the document (must be valid JSON)
      --repository=<value>         The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                   for Azure DevOps
      --sfp-server-url=<value>     URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                   config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Update a document in the doc store

EXAMPLES
  $ sfp server doc-store update --key myKey --value '{"data": "value"}' --current-version 1 --email user@example.com

  $ sfp server doc-store update --key myKey --value '{"data": "value"}' --current-version 1 --application-token myToken

  $ sfp server doc-store update --key myKey --file ./data.json --current-version 1 --email user@example.com

  $ sfp server doc-store update --key myKey --file ./image.png --upsert --email user@example.com

See code: src/commands/server/doc-store/update.ts

Callback

Previous Page

Environment

Next Page

On this page

sfp server doc-store addsfp server doc-store collection addsfp server doc-store collection deletesfp server doc-store collection getsfp server doc-store collection listsfp server doc-store collection updatesfp server doc-store deletesfp server doc-store getsfp server doc-store update