Vault

Struct for a document vault.

Full name	`MFiles.Vault`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`vault`	`VaultBasic`	1	Basic data.
`main_data_folder`	`string`	2	The main physical folder of this vault on the server (e.g. C:\Program Files\M-Files\Server Vaults\MyVault).
`additional_data_folders`	repeated `AdditionalFolder`	3	The specification of the additional file data folders.
`database_info`	`SQLDatabase`	4	The vault's SQL database.
`file_data_storage`	`FileDataStorage`	5	Identifies file data storage to use. Typically specifies that the file data storage is determined automatically.Values: `FILE_DATA_STORAGE_DEFAULT` (0), `FILE_DATA_STORAGE_DISK` (1), `FILE_DATA_STORAGE_DATABASE` (2), `FILE_DATA_STORAGE_EXTERNAL` (3), `FILE_DATA_STORAGE_MASTER` (4).
`file_data_connection_string`	`string`	6	The connection string that identifies the location, protocol, and credentials for the file data storage of this vault. For example, this might specify a storage account, a protocol, and a container name for Azure's BLOB Services. Can be unset or empty.

Used by methods

IRPCVaultsAdmin.AttachExistingVault -- Attaches an existing vault (metadata database and file data files) to the server.
IRPCVaultsAdmin.AttachVaultToOneDbTest -- Checks whether existing vault files can be attached on a server that has joined a subscription, without attaching them.
IRPCVaultsAdmin.CreateNewGroundLinkProxy -- Creates a ground link proxy, a vault of type VAULT_TYPE_GROUND_LINK_PROXY.
IRPCVaultsAdmin.CreateNewVault -- Creates a new document vault.
IRPCVaultsAdmin.UpdateVault -- Changes the definition of a vault: name and other registration data, data folders, database, file data storage and vault variables.
IRPCVaultsAdminBasic.GetVaultAdmin -- Gets one ordinary vault with its administrative details.
IRPCVaultsAdminBasic.GetVaultsAdmin -- Lists the ordinary vaults of the server (not replicas or Ground Link proxies) with their administrative details, including offline vaults.

Used in fields

CopyVaultJob.target_vault -- The definition of the target vault. The GUID field is ignored. The server will generate a new GUID for the new vault.
CopyVaultJobOutputInfo.new_vault -- Receives the full definition of the new vault.
MigrateVaultJob.target_vault -- The vault to migrate. Holds information on the target database engine, for example.
RestoreJob.target_vault -- The definition of the vault. If the GUID field is GUID_NULL, the restored vault uses the GUID specified in the backup files. Otherwise, it uses the given GUID (= restore to a different identity).
RestoreJobOutputInfo.restored_vault -- Receives the full definition of the restored vault.
VaultEx.vault -- Basic data.
AttachVaultToOneDbTestRequest.vault -- The vault files to check: data folders and database, as for AttachExistingVault.
CreateNewVaultRequest.vault -- The definition of the new vault: name (vault.vault.display_name), data folder (vault.main_data_folder), database (vault.database_info) and file data storage. vault.vault.guid is ignored: the server generates a new GUID.
CreateNewVaultResponse.new_vault -- The full definition of the new vault, including its new GUID.
UpdateVaultRequest.vault_info -- The new definition. A vault_info.vault.guid different from guid changes the vault's GUID. An empty vault_info.database_info.database_name leaves the database settings unchanged.
CreateNewGroundLinkProxyResponse.new_vault -- Receives the full definition of the new vault.
AttachExistingVaultRequest.vault -- Where the vault's files are: data folders and database. If vault.vault.guid is the null GUID, the vault keeps the GUID stored in its files; otherwise its GUID is changed to the given one.
AttachExistingVaultResponse.attached_vault -- Receives the full definition of the attached vault.
GetVaultsAdminResponse.vaults -- The vaults. With can_manage_vaults all fields are filled except database credentials; otherwise only the basic data (vault: GUID, name, host names). See Vault.
GetVaultAdminResponse.vault -- The vault. The fields filled depend on the caller (see the remarks). See Vault.