public class AdminServerClient extends Object implements IAdminDatabaseCommands, IGlobalAdminDatabaseCommands
Modifier and Type | Field and Description |
---|---|
protected AdminRequestCreator |
adminRequest |
protected ServerClient |
innerServerClient |
Constructor and Description |
---|
AdminServerClient(ServerClient serverClient) |
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 databaseName)
Used to delete a database from a server, with a possibility to remove all the data from hard drive.
|
void |
deleteDatabase(String databaseName,
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
|
RavenJObject |
getDatabaseConfiguration()
Gets configuration for current database.
|
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
|
String |
getIndexingStatus()
Get the indexing status
|
AdminStatistics |
getStatistics()
Gets server-wide statistics.
|
void |
startBackup(String backupLocation,
DatabaseDocument databaseDocument,
boolean incremental,
String databaseName)
Begins a backup operation
|
void |
startIndexing()
Enables indexing
|
void |
startIndexing(Integer maxNumberOfParallelIndexTasks)
Enables indexing
|
Operation |
startRestore(DatabaseRestoreRequest restoreRequest)
Begins a restore operation
|
void |
stopIndexing()
Disables all indexing
|
protected final ServerClient innerServerClient
protected final AdminRequestCreator adminRequest
public AdminServerClient(ServerClient serverClient)
public BuildNumber getBuildNumber()
IGlobalAdminDatabaseCommands
getBuildNumber
in interface IGlobalAdminDatabaseCommands
public void createDatabase(DatabaseDocument databaseDocument)
IGlobalAdminDatabaseCommands
createDatabase
in interface IGlobalAdminDatabaseCommands
public void deleteDatabase(String databaseName)
IGlobalAdminDatabaseCommands
deleteDatabase
in interface IGlobalAdminDatabaseCommands
databaseName
- Name of a database to deletepublic void deleteDatabase(String databaseName, boolean hardDelete)
IGlobalAdminDatabaseCommands
deleteDatabase
in interface IGlobalAdminDatabaseCommands
databaseName
- Name of a database to deletehardDelete
- Should all data be removed (data files, indexing files, etc.). Default: falsepublic IDatabaseCommands getCommands()
IGlobalAdminDatabaseCommands
getCommands
in interface IGlobalAdminDatabaseCommands
public Operation compactDatabase(String databaseName)
IGlobalAdminDatabaseCommands
compactDatabase
in interface IGlobalAdminDatabaseCommands
databaseName
- Name of a database to compactpublic void stopIndexing()
IAdminDatabaseCommands
stopIndexing
in interface IAdminDatabaseCommands
public void startIndexing()
IAdminDatabaseCommands
startIndexing
in interface IAdminDatabaseCommands
public void startIndexing(Integer maxNumberOfParallelIndexTasks)
IAdminDatabaseCommands
startIndexing
in interface IAdminDatabaseCommands
maxNumberOfParallelIndexTasks
- If set then maximum number of parallel indexing tasks will be set to this value.public void startBackup(String backupLocation, DatabaseDocument databaseDocument, boolean incremental, String databaseName)
IGlobalAdminDatabaseCommands
startBackup
in interface IGlobalAdminDatabaseCommands
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 uppublic Operation startRestore(DatabaseRestoreRequest restoreRequest)
IGlobalAdminDatabaseCommands
startRestore
in interface IGlobalAdminDatabaseCommands
public String getIndexingStatus()
IAdminDatabaseCommands
getIndexingStatus
in interface IAdminDatabaseCommands
public RavenJObject getDatabaseConfiguration()
IAdminDatabaseCommands
getDatabaseConfiguration
in interface IAdminDatabaseCommands
public String[] getDatabaseNames(int pagesize)
IGlobalAdminDatabaseCommands
getDatabaseNames
in interface IGlobalAdminDatabaseCommands
public String[] getDatabaseNames(int pageSize, int start)
IGlobalAdminDatabaseCommands
getDatabaseNames
in interface IGlobalAdminDatabaseCommands
public AdminStatistics getStatistics()
IGlobalAdminDatabaseCommands
getStatistics
in interface IGlobalAdminDatabaseCommands
public void ensureDatabaseExists(String name, boolean ignoreFailures)
IGlobalAdminDatabaseCommands
ensureDatabaseExists
in interface IGlobalAdminDatabaseCommands
public void ensureDatabaseExists(String name)
IGlobalAdminDatabaseCommands
ensureDatabaseExists
in interface IGlobalAdminDatabaseCommands
Copyright © 2016. All Rights Reserved.