| home > API > [/database/info] > |
| request url |
http://[SERVER]:[PORT]/database/info[?PARAMETER1=value[&...]] |
| short description |
Returns database information. |
| long description |
|
| parameters |
| name |
type |
description |
| database |
identifier |
Identifier of the database |
| name_database |
string |
Name of the database. Used only if database parameter is omitted. |
| show_permission |
boolean |
If 1 then additional information about the user's permission on database is returned (optional, default is 0) |
| show_counters |
boolean |
If 1 then the database's load time and memory size are returned (optional, default is 0) |
| mode |
integer |
If 1 then only database files sizes information is shown (optional, default is 0, returns [folder_size, archives_size, memory_size, use_csv]) |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
|
| result |
| # |
name |
type |
description |
| 0 |
database |
identifier |
Identifier of the database |
| 1 |
name_database |
string |
Name of the database |
| 2 |
number_dimensions |
integer |
Number of dimensions in the database |
| 3 |
number_cubes |
integer |
Number of cubes in the database |
| 4 |
status |
integer |
Status of database (0=unloaded, 1=loaded, 2=changed, 3=error) |
| 5 |
type |
integer |
Type of database (0=normal, 1=system, 3=user info) |
| 6 |
database_token |
integer |
The database token of the database |
| 7 |
permission |
string |
User's permission on database, maximum over all groups/roles ("N", "R", "W", "D") |
| 8 |
load_time |
double |
Load time of the database in seconds |
| 9 |
memory_size |
intenger |
Size of memory in bytes |
|
| examples |
|
| further information |
|