public interface IGlobalAdminDatabaseCommands
Modifier and Type | Method and Description |
---|---|
Operation |
compactDatabase(String databaseName)
Sends an async command to compact a database.
|
void |
createDatabase(DatabaseDocument databaseDocument)
Creates a database
|
void |
deleteDatabase(String dbName)
Used to delete a database from a server, with a possibility to remove all the data from hard drive.
|
void |
deleteDatabase(String dbName,
boolean hardDelete)
Used to delete a database from a server, with a possibility to remove all the data from hard drive.
|
void |
ensureDatabaseExists(String name)
Ensures that the database exists, creating it if needed
|
void |
ensureDatabaseExists(String name,
boolean ignoreFailures)
Ensures that the database exists, creating it if needed
|
BuildNumber |
getBuildNumber()
Gets the build number
|
IDatabaseCommands |
getCommands()
Gets DatabaseCommands
|
String[] |
getDatabaseNames(int pageSize)
Returns the names of all tenant databases on the RavenDB server
|
String[] |
getDatabaseNames(int pageSize,
int start)
Returns the names of all tenant databases on the RavenDB server
|
AdminStatistics |
getStatistics()
Gets server-wide statistics.
|
void |
startBackup(String backupLocation,
DatabaseDocument databaseDocument,
boolean incremental,
String databaseName)
Begins a backup operation
|
Operation |
startRestore(DatabaseRestoreRequest restoreRequest)
Begins a restore operation
|
BuildNumber getBuildNumber()
String[] getDatabaseNames(int pageSize)
pageSize
- String[] getDatabaseNames(int pageSize, int start)
pageSize
- start
- AdminStatistics getStatistics()
void createDatabase(DatabaseDocument databaseDocument)
databaseDocument
- void deleteDatabase(String dbName)
dbName
- Name of a database to deletevoid deleteDatabase(String dbName, boolean hardDelete)
dbName
- Name of a database to deletehardDelete
- Should all data be removed (data files, indexing files, etc.). Default: falseOperation compactDatabase(String databaseName)
databaseName
- Name of a database to compactIDatabaseCommands getCommands()
Operation startRestore(DatabaseRestoreRequest restoreRequest)
restoreRequest
- void startBackup(String backupLocation, DatabaseDocument databaseDocument, boolean incremental, String databaseName)
backupLocation
- Path to directory where backup will be storeddatabaseDocument
- Database configuration document that will be stored with backup in 'Database.Document'
file. Pass null to use the one from system database. WARNING: Database configuration document may contain
sensitive data which will be decrypted and stored in backup.incremental
- Indicates if backup is incrementaldatabaseName
- Name of a database that will be backed upvoid ensureDatabaseExists(String name)
name
- void ensureDatabaseExists(String name, boolean ignoreFailures)
name
- ignoreFailures
- Copyright © 2016. All Rights Reserved.