Jedox OLAP documentation

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])
show_count_by_type boolean If 1 then count of different types of dimensions and cubes is returned (optional, default is 0, returns [number_normal_dimensions, ..., number_gpu_cubes])
show_error boolean If 1 then information about occurrent error during database load is returned (optional, default is 0, returns [error code, description, message, details])
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
10 number_normal_dimensions intenger Number of Normal dimensions in the database
11 number_system_dimensions intenger Number of System dimensions in the database
12 number_attribute_dimensions intenger Number of Attributes dimensions (including UserInfo related Attributes dimensions) in the database
13 number_userinfo_dimensions intenger Number of UserInfo dimensions in the database
14 number_userinfo_related_attrite_dimensions intenger Number of Attributes dimensions related to UserInfo dimensions in the database
15 number_normal_cubes intenger Number of Normal cubes in the database
16 number_system_cubes intenger Number of System cubes (including Rights cubes) in the database
17 number_attribute_cubes intenger Number of Attributes cubes (including UserInfo related Attributes cubes) in the database
18 number_userinfo_cubes intenger Number of UserInfo cubes in the database
19 number_rights_cubes intenger Number of Rights cubes (including UserInfo related Rights cubes) in the database
20 number_cellproperty_cubes intenger Number of CellProperties cubes (including UserInfo related CellProprties cubes) in the database
21 number_userinfo_related_attrite_cubes intenger Number of Attributes cubes related to UserInfo dimensions in the database
22 number_userinfo_related_cellproperty_cubes intenger Number of CellProperties cubes related to UserInfo cubes in the database
23 number_userinfo_related_rights_cubes intenger Number of Rights cubes related to UserInfo dimensions in the database
24 number_gpu_cubes intenger Number of Gpu cubes in the database
25 error_code intenger Error code (error during database load)
26 error_description string Error description (error during database load)
27 error_message string Error message (error during database load)
28 error_details string Error details (error during database load)
examples
description
Show info of database "1"
Show info of database "2" including number of dimensions and cubes of different types
further information
Copyright 2005-2020 Jedox AG