Set up process #

Firestore Source Plugin

Authentication #

Configuration #

kind: source
spec:
  # Source spec section
  name: firestore
  path: cloudquery/firestore
  registry: cloudquery
  version: "v4.4.0"
  tables: ["*"]
  destinations: ["postgresql"]
  # Learn more about the configuration options at https://cql.ink/firestore_source
  spec:
    # Firestore specific configuration goes here

Firestore Source Plugin Configuration Reference

Example #

kind: source
spec:
  # Source spec section
  name: "firestore"
  path: "cloudquery/firestore"
  version: "v4.4.0"
  destinations: ["postgresql"]
  tables: ["*"]
  spec:
    # Firestore Spec section described below
    project_id: "my-project"

Firestore Spec #

• project_id ([]string) (optional) (default: auto detect. Will detect the project id from the credentials)

  Specify project id to use when syncing Firestore resources. If not specified, the project id will be auto detected from the credentials. See more about auto detection here
• service_account_json (string) (optional) (default: empty).

  Firestore service account JSON content. Using service accounts is not recommended, but if it is used it is better to use environment or file variable substitution.
• use_base64 (boolean) (optional) (default: false). If true, the service account JSON content will treated as base64 encoded, and will be decoded before being used.
• rows_per_record (integer) (optional) (default: 500)

  Amount of rows to be packed into a single Apache Arrow record to be sent over the wire during sync.
• max_batch_size (integer) (optional) (default: 50000)

  Maximum batch size for each request when reading Firestore data. You might need to be configure it depending on row data size and system resources.
• order_by (string) (optional) (default: empty)

  The field(s) to order the results by. If not specified, the results will be ordered by document id. This requires you to add an index on the field(s), which can only be done on the Firebase UI right now. See more here
• order_direction (string) (optional) (default: empty)

  The direction to order the results by. Only used when order_by is specified. Accepts asc or desc, and if not specified the results will be ordered in ascending order.