Home Server browser API Documentation Jedox OLAP Home

Jedox OLAP documentation

home > API > [/server/databases] >

request url

https://[SERVER]:[PORT]/server/databases[?PARAMETER1=value[&...]]

short description

Returns the list of databases.

long description

Passible status of a database

unloaded: the saved databases is not loaded to memory. Number of of dimensions and cubes are not set.
loaded: the database is loaded into memory and no modifications have been made since the last save.
changed: the database is loaded into memory and modifications exists since the last save. Or the database is newly created.

parameters

name	type	description
show_normal	identifier	Show databases of type normal (0=do not show normal databases, 1=show (default))
show_system	identifier	Show databases of type system (0=do not show system databases (default), 1=show)
show_user_info	identifier	Show databases of type user info (0=do not show user info databases (default), 1=show)
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)
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])
show_virtual	boolean	If 1 and show_count_by_type=1 then return the count of virtual attribute dimensions (number_virtual_dimensions)
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	integer	Size of memory in bytes
10	number_normal_dimensions	integer	Number of Normal dimensions in the database
11	number_system_dimensions	integer	Number of System dimensions in the database
12	number_attribute_dimensions	integer	Number of Attributes dimensions (including UserInfo related Attributes dimensions) in the database
13	number_userinfo_dimensions	integer	Number of UserInfo dimensions in the database
14	number_userinfo_related_attribute_dimensions	integer	Number of Attributes dimensions related to UserInfo dimensions in the database
15	number_virtual_dimensions	integer	Number of Virtual attribute dimensions in the database (only if show_virtual=1)
16	number_normal_cubes	integer	Number of Normal cubes in the database
17	number_system_cubes	integer	Number of System cubes (including Rights cubes) in the database
18	number_attribute_cubes	integer	Number of Attributes cubes (including UserInfo related Attributes cubes) in the database
19	number_userinfo_cubes	integer	Number of UserInfo cubes in the database
20	number_rights_cubes	integer	Number of Rights cubes (including UserInfo related Rights cubes) in the database
21	number_cellproperty_cubes	integer	Number of CellProperties cubes (including UserInfo related CellProprties cubes) in the database
22	number_userinfo_related_attribute_cubes	integer	Number of Attributes cubes related to UserInfo dimensions in the database
23	number_userinfo_related_cellproperty_cubes	integer	Number of CellProperties cubes related to UserInfo cubes in the database
24	number_userinfo_related_rights_cubes	integer	Number of Rights cubes related to UserInfo dimensions in the database
25	number_gpu_cubes	integer	Number of Gpu cubes in the database
26	error_code	integer	Error code (error during database load)
27	error_description	string	Error description (error during database load)
28	error_message	string	Error message (error during database load)
29	error_details	string	Error details (error during database load)

examples

description

List the databases of the server

List the databases of the server with show_count_by_type=1

further information