JedoxodatahubClient

Attributes

CellArray module-attribute

CellArray = List['Cell']

CubeArray module-attribute

CubeArray = List['Cube']

DatabaseArray module-attribute

DatabaseArray = List['Database']

DimensionArray module-attribute

DimensionArray = List['Dimension']

ElementArray module-attribute

ElementArray = List['Element']

IntegratorComponentArray module-attribute

IntegratorComponentArray = List['IntegratorComponent']

IntegratorExtractComponentRowArray module-attribute

IntegratorExtractComponentRowArray = List['IntegratorExtractComponentRow']

IntegratorProjectArray module-attribute

IntegratorProjectArray = List['IntegratorProject']

IntegratorProjectGroupArray module-attribute

IntegratorProjectGroupArray = List['IntegratorProjectGroup']

IntegratorTransformComponentRowArray module-attribute

IntegratorTransformComponentRowArray = List['IntegratorTransformComponentRow']

ViewArray module-attribute

ViewArray = List['View']

ViewCellArray module-attribute

ViewCellArray = List['ViewCell']

Classes

DatabasesResponse dataclass

DatabasesResponse(value: Optional[DatabaseArray] = None)

Response for Get databases

Database dataclass

Database(cube_count: Optional[int] = None, dimension_count: Optional[int] = None, id: Optional[int] = None, name: Optional[str] = None, type_: Optional[str] = None)

Response for Get database by id

CubesResponse dataclass

CubesResponse(value: Optional[CubeArray] = None)

Response for Get cubes

Cube dataclass

Cube(filled_cell_count: Optional[int] = None, id: Optional[int] = None, name: Optional[str] = None, type_: Optional[str] = None)

Response for Get cube by ID

CubeCellsResponse dataclass

CubeCellsResponse(value: Optional[CellArray] = None)

Response for Get cube cells

DimensionsResponse dataclass

DimensionsResponse(value: Optional[DimensionArray] = None)

Response for Get dimensions

Dimension dataclass

Dimension(element_count: Optional[int] = None, id: Optional[int] = None, name: Optional[str] = None, type_: Optional[str] = None)

Response for Get dimension by ID

ElementsResponse dataclass

ElementsResponse(value: Optional[ElementArray] = None)

Response for Get elements

Element dataclass

Element(id: Optional[int] = None, name: Optional[str] = None, position: Optional[int] = None, type_: Optional[str] = None, weight: Optional[float] = None)

Response for Get element by ID

ViewsResponse dataclass

ViewsResponse(value: Optional[ViewArray] = None)

Response for Get stored views

View dataclass

View(creation_date: Optional[str] = None, cube_id: Optional[int] = None, cube_name: Optional[str] = None, description: Optional[str] = None, friendly_name: Optional[str] = None, global_: Optional[bool] = None, id: Optional[str] = None, user_name: Optional[str] = None)

Response for Get stored view by ID

ViewCellsResponse dataclass

ViewCellsResponse(value: Optional[ViewCellArray] = None)

Response for Get stored view cells

IntegratorProjectGroupsResponse dataclass

IntegratorProjectGroupsResponse(value: Optional[IntegratorProjectGroupArray] = None)

Response for Get Integrator project groups

IntegratorProjectGroup dataclass

IntegratorProjectGroup(description: Optional[str] = None, developer: Optional[str] = None, friendly_name: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, namespace: Optional[str] = None, version: Optional[str] = None)

Response for Get Integrator project group by identifier

IntegratorProjectsResponse dataclass

IntegratorProjectsResponse(value: Optional[IntegratorProjectArray] = None)

Response for Get Integrator projects

IntegratorProject dataclass

IntegratorProject(description: Optional[str] = None, modification_date: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None)

Response for Get Integrator project by name

ExtractsResponse dataclass

ExtractsResponse(value: Optional[IntegratorComponentArray] = None)

Response for Get extracts

IntegratorComponent dataclass

IntegratorComponent(description: Optional[str] = None, modification_date: Optional[str] = None, name: Optional[str] = None, type_: Optional[str] = None)

Response for Get extract by Name

ExtractRowsResponse dataclass

ExtractRowsResponse(value: Optional[IntegratorExtractComponentRowArray] = None)

Response for Get extract rows

JobsResponse dataclass

JobsResponse(value: Optional[IntegratorComponentArray] = None)

Response for Get jobs

IntegratorRunResult dataclass

IntegratorRunResult(errors: Optional[int] = None, execution_type: Optional[str] = None, id: Optional[int] = None, start_date: Optional[str] = None, status: Optional[str] = None, trace_available: Optional[bool] = None, warnings: Optional[int] = None)

Response for Run job

LoadsResponse dataclass

LoadsResponse(value: Optional[IntegratorComponentArray] = None)

Response for Get loads

TransformsResponse dataclass

TransformsResponse(value: Optional[IntegratorComponentArray] = None)

Response for Get transforms

TransformRowsResponse dataclass

TransformRowsResponse(value: Optional[IntegratorTransformComponentRowArray] = None)

Response for Get transform Rows

GetCubeCellResultSchemaResponse dataclass

GetCubeCellResultSchemaResponse(additional_properties: Dict[str, Any] = dict())

Response for Get Cube Cell Result Schema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetExtractRowsResultSchemaResponse dataclass

GetExtractRowsResultSchemaResponse(additional_properties: Dict[str, Any] = dict())

Response for Get Extract Rows Result Schema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetTransformRowsResultSchemaResponse dataclass

GetTransformRowsResultSchemaResponse(additional_properties: Dict[str, Any] = dict())

Response for Get Transform Rows Result Schema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetViewCellResultSchemaResponse dataclass

GetViewCellResultSchemaResponse(additional_properties: Dict[str, Any] = dict())

Response for Get View Cell Result Schema

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Cell dataclass

Cell(additional_properties: Dict[str, Any] = dict())

Definition: Cell

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Error dataclass

Error(error: Optional[str] = None)

Definition: Error

IntegratorExtractComponentRow dataclass

IntegratorExtractComponentRow(additional_properties: Dict[str, Any] = dict())

Definition: IntegratorExtractComponentRow

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

IntegratorTransformComponentRow dataclass

IntegratorTransformComponentRow(additional_properties: Dict[str, Any] = dict())

Definition: IntegratorTransformComponentRow

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ViewCell dataclass

ViewCell(additional_properties: Dict[str, Any] = dict())

Definition: ViewCell

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

JedoxodatahubClient

JedoxodatahubClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for jedoxodatahub connector.

Initialize a JedoxodatahubClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

databases_async async

databases_async(top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get databases

Get a list of databases found in the server. System and config databases are excluded from the list, but can be requested by providing the ID.

database_by_id_async async

database_by_id_async(database_id: int) -> dict[str, Any] | None

Get database by id

Get the database with the given ID.

cubes_async async

cubes_async(database_id: int, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get cubes

Get a list of cubes in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. #_Years to ATT_Years.

cube_by_id_async async

cube_by_id_async(database_id: int, cube_id: int) -> dict[str, Any] | None

Get cube by ID

Get the cube with the given ID in the given database. To prevent issues with the URL encodings, Attribute cubes will be renamed, e.g. #_Years to ATT_Years.

cube_cells_async async

cube_cells_async(database_id: int, cube_id: int, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, baseonly: Optional[bool] = None, userules: Optional[bool] = None, zerosupression: Optional[bool] = None, disablepaging: Optional[bool] = None) -> dict[str, Any] | None

Get cube cells

Get the cells from a cube. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties.

dimensions_async async

dimensions_async(database_id: int, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get dimensions

Get a list of dimensions in the given database.

dimension_by_id_async async

dimension_by_id_async(database_id: int, dimension_id: int) -> dict[str, Any] | None

Get dimension by ID

Get the dimension with the given ID in the given database.

elements_async async

elements_async(database_id: int, dimension_id: int, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get elements

Get a list of elements in the given dimension.

element_by_id_async async

element_by_id_async(database_id: int, dimension_id: int, element_id: int) -> dict[str, Any] | None

Get element by ID

Returns the element with the given ID in the given dimension.

views_async async

views_async(database_id: int, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get stored views

Get a list of stored views in the given database.

view_by_id_async async

view_by_id_async(database_id: int, view_id: str) -> dict[str, Any] | None

Get stored view by ID

Get the view with the given ID in the given database.

view_cells_async async

view_cells_async(database_id: int, view_id: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, baseonly: Optional[bool] = None, userules: Optional[bool] = None, zerosupression: Optional[bool] = None, disablepaging: Optional[bool] = None) -> dict[str, Any] | None

Get stored view cells

Get all cells from a view. This returns the cells' values and element names. If the cell has a string value, the value is instead stored in the stringValue field. Element names are stored in dynamic properties.

integrator_project_groups_async async

integrator_project_groups_async(top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get Integrator project groups

Get a list of integrator project groups found in the server.

integrator_projects_by_id_async async

integrator_projects_by_id_async(group_identifier: str) -> dict[str, Any] | None

Get Integrator project group by identifier

Get the project group with the given ID.

integrator_projects_async async

integrator_projects_async(group_identifier: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get Integrator projects

Get a list of integrator projects found in the server.

integrator_projects_by_name_async async

integrator_projects_by_name_async(group_identifier: str, project_name: str) -> dict[str, Any] | None

Get Integrator project by name

Get the integrator project with the given name.

extracts_async async

extracts_async(group_identifier: str, project_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get extracts

Get a list of extracts in the given integrator project.

extract_by_name_async async

extract_by_name_async(group_identifier: str, project_name: str, extract_name: str) -> dict[str, Any] | None

Get extract by Name

Get the extract with the given name in the given integrator project.

extract_rows_async async

extract_rows_async(group_identifier: str, project_name: str, extract_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get extract rows

Stream the rows of the extract with the given name in the given integrator project.

jobs_async async

jobs_async(group_identifier: str, project_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get jobs

Get a list of jobs in the given integrator project.

job_by_name_async async

job_by_name_async(group_identifier: str, project_name: str, job_name: str) -> dict[str, Any] | None

Get job by name

Get the jobs with the given name in the given integrator project.

run_job_async async

run_job_async(group_identifier: str, project_name: str, job_name: str) -> dict[str, Any] | None

Run job

Run the job with the given name in the given integrator project. The execution will be added to the queue.

run_job_with_variables_async async

run_job_with_variables_async(group_identifier: str, project_name: str, job_name: str, variables: str) -> dict[str, Any] | None

Run job with variables

Run the job with the given name in the given integrator project. The execution will be added to the queue.

loads_async async

loads_async(group_identifier: str, project_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get loads

Get a list of loads in the given integrator project.

load_by_name_async async

load_by_name_async(group_identifier: str, project_name: str, load_name: str) -> dict[str, Any] | None

Get load by name

Get the transform with the given name in the given integrator project.

run_load_async async

run_load_async(group_identifier: str, project_name: str, load_name: str) -> dict[str, Any] | None

Run load

Run the load with the given name in the given integrator project. The execution will be added to the queue.

run_load_with_variables_async async

run_load_with_variables_async(group_identifier: str, project_name: str, load_name: str, variables: str) -> dict[str, Any] | None

Run load with variables

Run the load with the given name in the given integrator project. The execution will be added to the queue.

transforms_async async

transforms_async(group_identifier: str, project_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get transforms

Get a list of transforms in the given integrator project.

transform_by_name_async async

transform_by_name_async(group_identifier: str, project_name: str, transform_name: str) -> dict[str, Any] | None

Get transform by name

Get the transform with the given name in the given integrator project.

transform_rows_async async

transform_rows_async(group_identifier: str, project_name: str, transform_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None) -> dict[str, Any] | None

Get transform Rows

Stream the rows of the transform with the given name in the given integrator project.

get_cube_cell_result_schema_async async

get_cube_cell_result_schema_async(database_id: int, cube_id: int) -> dict[str, Any] | None

Get Cube Cell Result Schema

Service request for getting the schema used for the result of cube cells.

get_extract_rows_result_schema_async async

get_extract_rows_result_schema_async(group_identifier: str, project_name: str, extract_name: str) -> dict[str, Any] | None

Get Extract Rows Result Schema

Service request for getting the schema used for the result of extract rows.

get_transform_rows_result_schema_async async

get_transform_rows_result_schema_async(group_identifier: str, project_name: str, transform_name: str) -> dict[str, Any] | None

Get Transform Rows Result Schema

Service request for getting the schema used for the result of transform rows.

get_view_cell_result_schema_async async

get_view_cell_result_schema_async(database_id: int, view_id: str) -> dict[str, Any] | None

Get View Cell Result Schema

Service request for getting the schema used for the result of view cells.