JedoxodatahubClient

Attributes

CellArray module-attribute

CellArray = List['Cell | Mapping[str, Any]']

CubeArray module-attribute

CubeArray = List['Cube | Mapping[str, Any]']

DatabaseArray module-attribute

DatabaseArray = List['Database | Mapping[str, Any]']

DimensionArray module-attribute

DimensionArray = List['Dimension | Mapping[str, Any]']

ElementArray module-attribute

ElementArray = List['Element | Mapping[str, Any]']

IntegratorComponentArray module-attribute

IntegratorComponentArray = List['IntegratorComponent | Mapping[str, Any]']

IntegratorExtractComponentRowArray module-attribute

IntegratorExtractComponentRowArray = List['IntegratorExtractComponentRow | Mapping[str, Any]']

IntegratorProjectArray module-attribute

IntegratorProjectArray = List['IntegratorProject | Mapping[str, Any]']

IntegratorProjectGroupArray module-attribute

IntegratorProjectGroupArray = List['IntegratorProjectGroup | Mapping[str, Any]']

IntegratorTransformComponentRowArray module-attribute

IntegratorTransformComponentRowArray = List['IntegratorTransformComponentRow | Mapping[str, Any]']

ViewArray module-attribute

ViewArray = List['View | Mapping[str, Any]']

ViewCellArray module-attribute

ViewCellArray = List['ViewCell | Mapping[str, Any]']

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default_factory=dict, kw_only=True)

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

JedoxodatahubClient

JedoxodatahubClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_databases

list_databases(*, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

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.

Returns a single-page Azure Core async collection.

Swagger operation ID: Databases.

Parameters:

Name	Type	Description	Default
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

database_by_id async

database_by_id(database_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get database by id

Get the database with the given ID.

Swagger operation ID: DatabaseById.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_cubes

list_cubes(database_id: int, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

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.

Returns a single-page Azure Core async collection.

Swagger operation ID: Cubes.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

cube_by_id async

cube_by_id(database_id: int, cube_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: CubeById.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
cube_id	int	Numeric ID of the cube.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_cube_cells

list_cube_cells(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

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.

Returns a single-page Azure Core async collection.

Swagger operation ID: CubeCells.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
cube_id	int	Numeric ID of the cube.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation. Currently the /Cells functions only support basic operations. Complex formulas might return an invalid result. For complex filtering, please use Views.	None
baseonly	Optional[bool]	If set to true, the result will only contain base elements. If set to false, it will also contain consolidated elements.	None
userules	Optional[bool]	If set to true, rules will be applied to the resulting cells.	None
zerosupression	Optional[bool]	If set to true, numeric cells with a value of 0 and empty string cells will be removed from the result.	None
disablepaging	Optional[bool]	If set to true, the service will return the entire result instead of a single page. With this option set to true, the response might take multiple minutes depending on the cube's size.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_dimensions

list_dimensions(database_id: int, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get dimensions

Get a list of dimensions in the given database.

Returns a single-page Azure Core async collection.

Swagger operation ID: Dimensions.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

dimension_by_id async

dimension_by_id(database_id: int, dimension_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get dimension by ID

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

Swagger operation ID: DimensionById.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
dimension_id	int	Numeric ID of the dimension.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_elements

list_elements(database_id: int, dimension_id: int, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get elements

Get a list of elements in the given dimension.

Returns a single-page Azure Core async collection.

Swagger operation ID: Elements.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
dimension_id	int	Numeric ID of the dimension.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

element_by_id async

element_by_id(database_id: int, dimension_id: int, element_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get element by ID

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

Swagger operation ID: ElementById.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
dimension_id	int	Numeric ID of the dimension.	required
element_id	int	Numeric ID of the element.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_views

list_views(database_id: int, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get stored views

Get a list of stored views in the given database.

Returns a single-page Azure Core async collection.

Swagger operation ID: Views.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

view_by_id async

view_by_id(database_id: int, view_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get stored view by ID

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

Swagger operation ID: ViewById.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
view_id	str	UUID of the view.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_view_cells

list_view_cells(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

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.

Returns a single-page Azure Core async collection.

Swagger operation ID: ViewCells.

Parameters:

Name	Type	Description	Default
database_id	int	Numeric ID of the database.	required
view_id	str	UUID of the view.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation. Currently the /Cells functions only support basic operations. Complex formulas might return an invalid result.	None
baseonly	Optional[bool]	If set to true, the result will only contain base elements. If set to false, it will also contain consolidated elements.	None
userules	Optional[bool]	If set to true, rules will be applied to the resulting cells.	None
zerosupression	Optional[bool]	If set to true, numeric cells with a value of 0 and empty string cells will be removed from the result.	None
disablepaging	Optional[bool]	If set to true, the service will return the entire result instead of a single page. With this option set to true, the response might take multiple minutes depending on the view's size.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_integrator_project_groups

list_integrator_project_groups(*, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Integrator project groups

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

Returns a single-page Azure Core async collection.

Swagger operation ID: IntegratorProjectGroups.

Parameters:

Name	Type	Description	Default
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

integrator_projects_by_id async

integrator_projects_by_id(group_identifier: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Integrator project group by identifier

Get the project group with the given ID.

Swagger operation ID: IntegratorProjectsById.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_integrator_projects

list_integrator_projects(group_identifier: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get Integrator projects

Get a list of integrator projects found in the server.

Returns a single-page Azure Core async collection.

Swagger operation ID: IntegratorProjects.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

integrator_projects_by_name async

integrator_projects_by_name(group_identifier: str, project_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Integrator project by name

Get the integrator project with the given name.

Swagger operation ID: IntegratorProjectsByName.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_extracts

list_extracts(group_identifier: str, project_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get extracts

Get a list of extracts in the given integrator project.

Returns a single-page Azure Core async collection.

Swagger operation ID: Extracts.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

extract_by_name async

extract_by_name(group_identifier: str, project_name: str, extract_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get extract by Name

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

Swagger operation ID: ExtractByName.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
extract_name	str	The name of the extract.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_extract_rows

list_extract_rows(group_identifier: str, project_name: str, extract_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get extract rows

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ExtractRows.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
extract_name	str	The name of the extract.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_jobs

list_jobs(group_identifier: str, project_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get jobs

Get a list of jobs in the given integrator project.

Returns a single-page Azure Core async collection.

Swagger operation ID: Jobs.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

job_by_name async

job_by_name(group_identifier: str, project_name: str, job_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get job by name

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

Swagger operation ID: JobByName.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
job_name	str	The name of the job.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

run_job async

run_job(group_identifier: str, project_name: str, job_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: RunJob.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
job_name	str	The name of the job.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

run_job_with_variables async

run_job_with_variables(group_identifier: str, project_name: str, job_name: str, variables: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: RunJobWithVariables.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
job_name	str	The name of the job.	required
variables	str	Variable names and values separated by an equal sign. If a variable is omitted, the default value will be used. Multiple variables must be separated by commas. Example: Variables='SourceDB=Demo,TargetDB=Biker'.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_loads

list_loads(group_identifier: str, project_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get loads

Get a list of loads in the given integrator project.

Returns a single-page Azure Core async collection.

Swagger operation ID: Loads.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

load_by_name async

load_by_name(group_identifier: str, project_name: str, load_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get load by name

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

Swagger operation ID: LoadByName.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
load_name	str	The name of the load.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

run_load async

run_load(group_identifier: str, project_name: str, load_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: RunLoad.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
load_name	str	The name of the load.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

run_load_with_variables async

run_load_with_variables(group_identifier: str, project_name: str, load_name: str, variables: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: RunLoadWithVariables.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
load_name	str	The name of the load.	required
variables	str	Variable names and values separated by an equal sign. If a variable is omitted, the default value will be used. Multiple variables must be separated by commas. Example: Variables='SourceDB=Demo,TargetDB=Biker'.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_transforms

list_transforms(group_identifier: str, project_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get transforms

Get a list of transforms in the given integrator project.

Returns a single-page Azure Core async collection.

Swagger operation ID: Transforms.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

transform_by_name async

transform_by_name(group_identifier: str, project_name: str, transform_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get transform by name

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

Swagger operation ID: TransformByName.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
transform_name	str	The name of the transform.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_transform_rows

list_transform_rows(group_identifier: str, project_name: str, transform_name: str, *, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get transform Rows

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

Returns a single-page Azure Core async collection.

Swagger operation ID: TransformRows.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the Integrator project.	required
transform_name	str	The name of the transform.	required
top	Optional[int]	Limits the number of items returned by the given number. The service returns the number of available items up to but not greater than the specified value n.	None
skip	Optional[int]	Excludes the first n items of the queried collection from the result. The service returns items starting at position n+1.	None
filter	Optional[str]	The $filter system query option restricts the set of items returned. For a list of available operations and functions see the OData Documentation.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_cube_cell_result_schema async

get_cube_cell_result_schema(database_id: int, cube_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Cube Cell Result Schema

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

Swagger operation ID: GetCubeCellResultSchema.

Parameters:

Name	Type	Description	Default
database_id	int	The identifier of the Olap database.	required
cube_id	int	The identifier of the Olap cube.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_extract_rows_result_schema async

get_extract_rows_result_schema(group_identifier: str, project_name: str, extract_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Extract Rows Result Schema

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

Swagger operation ID: GetExtractRowsResultSchema.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the project.	required
extract_name	str	The name of the extract.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_transform_rows_result_schema async

get_transform_rows_result_schema(group_identifier: str, project_name: str, transform_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Transform Rows Result Schema

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

Swagger operation ID: GetTransformRowsResultSchema.

Parameters:

Name	Type	Description	Default
group_identifier	str	The identifier of the Integrator project group.	required
project_name	str	The name of the project.	required
transform_name	str	The name of the transform.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_view_cell_result_schema async

get_view_cell_result_schema(database_id: int, view_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get View Cell Result Schema

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

Swagger operation ID: GetViewCellResultSchema.

Parameters:

Name	Type	Description	Default
database_id	int	The identifier of the Olap database.	required
view_id	str	The identifier of the stored view.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.