Stores

A Store in beVault States is a configured physical endpoint that Workers use to access data. Stores serve as an abstraction layer for connections to external systems, encapsulating connection details, credentials, and technical configuration. This allows Workers to read from or write to databases and file systems through a uniform and secure interface.

Stores are divided into two categories:

  • dbStores (Category = Db): Database-oriented stores that enable connections to various database management systems such as PostgreSQL, SQL Server, Snowflake, Oracle, MySQL, IBM DB2, ODBC, or even Excel files.

  • fileStores (Category = File): File-oriented stores that enable file management across different storage systems, including local directories (file), SFTP and FTP(S) servers, Amazon S3/MinIO buckets, and GitLab repositories.

Stores can be configured in two ways:

  • Via the States interface — using the Data Stores module in the Configure section of States. Stores configured this way are centrally managed and automatically made available to all connected Workers.

  • Locally on the Worker — via a stores.json file or environment variables deployed directly on the Workers' server.

⚠️ Priority rule: When a store with the same name is defined both in the States interface and locally on a Worker, the local configuration always takes priority. The store will appear as Disabled in the States interface for that Worker's environment.


Base configuration

All stores have the same base configuration.

Name

Description

Type

Mandatory

Comment

Name

The name of the store.

string

True

Should be unique

Type

Type of the store

string

True


Status

Status of the store

string

False

“deleted”: the store is not used anymore and cannot be used

HealthCheck

Is a health check should be performed for this store?

bool

False


Config

Contains the configuration of the store

JSON

True


Example of the base configuration
JSON
{
	"Name": "df-staging",
	"Type": "postgresql",
	"HealthCheck": true,
	"Config": {
		"ConnectionString": ""
	}
}