Function Store
  • Home
  • Getting started
    • Introduction
    • Installing a function
    • Reconfiguring a function
    • Uninstalling a function
    • FAQs
  • Reference
    • Requirements
      • Assign Roles
        • User permissions
      • Link a Billing account to your project
      • Enable the APIs
    • Projects
      • How to add a project
      • How to set up a project
    • Functions
      • Benefits
      • Use cases
      • Authentication when installing
      • Runtime configuration
      • Deploying with a ZIP file
    • Policies
      • How to add a Policy
      • How to remove a Policy
    • Authentication
      • Users
      • Roles
      • Permissions
    • Secrets
      • Creating a Secret
      • Using a Secret
      • Changing the value for a Secret
      • Deactivating a Secret
  • developers
    • Overview
    • Getting Started
    • Set up
    • Workspaces
      • Create a workspace
      • Workspace boilerplate
      • Node engines
    • Writing Functions
      • Function Anatomy
      • Configuration file
      • Function Triggers
      • Environment Variables
        • Type "text"
        • Type "number"
        • Type "email"
        • Type "url"
        • Type "json"
        • Type "boolean"
        • Type "select"
        • Type "multiselect"
        • Type "firestoreDocumentPath"
        • Type "firestoreCollectionPath"
        • Type "color"
      • Documentation
    • Push/Update your functions in the cloud
    • Continuous Integration
    • Publish functions in the Marketplace
    • Emulators
      • Initialize emulators in your workspace
      • Environment variables
      • Starting emulators
      • Testing your functions in the emulator
      • Importing existing data into local emulators
        • Exporting data from Cloud Firestore to local emulator
        • Exporting user accounts from Firebase to local emulator
    • Visual Studio Code Extension
      • Installing the extension
      • Extension UI
      • Functions list
      • Creating and editing functions
      • Emulators
      • Extension settings
      • Troubleshooting
        • "Command not found" error when executing a command
  • Billing
    • Understanding Billing
  • Security
    • Security
  • Resources
    • Events and Triggers
    • Best Practices
      • How to log events in functions?
    • Document your Functions
    • Editorial guidelines
    • Our Processes
      • Use Cases Analysis
  • Use cases
    • Custom Stripe Checkout
Powered by GitBook
On this page
  • Example of an environment variable type "firestoreCollectionPath" definition
  • Example of how to consume the value of the environment variable within the function implementation
  • Properties of the type

Was this helpful?

  1. developers
  2. Writing Functions
  3. Environment Variables

Type "firestoreCollectionPath"

PreviousType "firestoreDocumentPath"NextType "color"

Last updated 3 years ago

Was this helpful?

Frequently you might find yourself writing a function that reads or writes into the Firestore database document. The same solution (the function code) could be used in the same project or in others, but reading or writing into different paths. For example, a function that syncs a Firestore collection with a BigQuery table could be used multiple times to synchronize different Firestore collections.

If you are writing a function that requires a document path in the Firestore database, either because you want to read or write to that document, you can use environment variables of type firestoreCollectionPath in your implementation, and then our platform will ask consumers to enter its value during installation.‌‌

The variables type firestoreCollectionPath allow the consumers of a function to enter any firestore document path valid. It is presented in the installation UI form as an input element (see image below).

‌

Example of an environment variable type "firestoreCollectionPath" definition

"env": [
    {
        "name": "STRIPE_CUSTOMERS_COLLECTION_PATH",
        "description": "The collection path where the Stripe customers are stored.",
        "required": true,
        "type": "firestoreCollectionPath",
        "default": "/users"
    }
]
‌

‌

Example of how to consume the value of the environment variable within the function implementation

const myFunction = () => {
    const collectionPath = process.env.COLLECTION_PATH
    ...
};

module.exports = myFunction;

Properties of the type

property

type

required

default

description

name

string

yes

-

The name of the environment variable. This should be unique for each variable.

description

string

no

-

The description of the environment variable.

default

string

no

-

The default value for the variable.

required

bool

no

false

Specifies that must fill out the variable before submitting.