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.jsonfile 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.
| Title | Description | Type | Category |
|---|---|---|---|
| Snowflake Db Store |
Connection to a Snowflake database |
snowflake |
Db |
| IBM db2 Db Store |
Connection to a IBM db2 database |
ibmdb2 |
Db |
| SqlServer Db Store |
Connection to a SQL Server database |
sqlserver |
Db |
| MySql Db Store |
Connection to a MySql database |
mysql |
Db |
| ODBC Db Store |
Connection to an ODBC database |
odbc |
Db |
| Oracle Store |
Connection to an Oracle database |
oracle |
Db |
| Excel Db Store |
Connection to an Excel file |
excel |
Db |
| PostgreSql Db Store |
Connection to a Postgres database |
postgresql |
Db |
| S3 File Store |
Connection to an Amazon/Minio S3 Bucket |
s3 |
File |
| Directory File Store |
A directory in the file system |
file |
File |
| Ftp File Store |
An FTP(S) server to manage files |
ftp |
File |
| Gitlab Store |
A gitlab repository |
gitlab |
File |
| Sftp File Store |
An SFTP server to manage files |
sftp |
File |
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
{
"Name": "df-staging",
"Type": "postgresql",
"HealthCheck": true,
"Config": {
"ConnectionString": ""
}
}