SQLDatabase

View as Markdown

Struct for the SQL database of a document vault.

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

Fields

Field	Type	Number	Description
`engine`	`DBEngine`	1	Database engine identification.Values: `DBENGINE_NONE` (0), `DBENGINE_FIREBIRD` (1), `DBENGINE_MS_SQL_SERVER` (2).
`server_name`	`string`	2	The data source i.e. the database server name where the vault's database is residing. This is specified for data service DB engines only. It is empty or unset for embedded databases such as Firebird Embedded.
`database_name`	`string`	3	The catalog i.e. the database name where the vault's data is residing. Allows the database name to differ from the vault display name. This is not specified in the Firebird case.
`system_admin_impersonation`	`Impersonation`	4	Impersonation information for accessing the database engine for administrative purposes. This contains SYSDBA (System Database Administrator) user name and password. If unset, the default user name and password are used.
`basic_user_impersonation`	`Impersonation`	5	Impersonation information for accessing the database engine in basic user operations that do not modify the database structure. This contains DB user name and password. If unset, the default user name and password are used.

Used by methods

IRPCVaultsAdmin.TestConnectionToSQLDatabase -- Tests whether the server can connect to a Microsoft SQL Server database, for example before creating a vault in it.

Used in fields

Vault.database_info -- The vault's SQL database.
TestConnectionToSQLDatabaseRequest.sqldb -- The database server, database name and credentials to test.