luminesce-sdk 2.2.31__tar.gz → 2.2.33__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/PKG-INFO +3 -2
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/README.md +2 -1
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/sql_background_execution_api.py +175 -24
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/configuration.py +1 -1
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/pyproject.toml +1 -1
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/__init__.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/__init__.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/application_metadata_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/binary_downloading_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/certificate_management_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/current_table_field_catalog_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/health_checking_endpoint_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/historically_executed_queries_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/multi_query_execution_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/sql_design_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/sql_execution_api.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api_client.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/exceptions.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/__init__.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/api_client.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/api_client_factory.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/api_configuration.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/configuration_loaders.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/configuration_options.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/file_access_token.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/proxy_config.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/refreshing_token.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/rest.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/retry.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/socket_keep_alive.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/tcp_keep_alive_connector.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/__init__.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/access_controlled_action.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/access_controlled_resource.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/access_controlled_resource_identifier_part_schema_attribute.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/action_id.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/aggregate_function.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/aggregation.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/auto_detect_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/available_field.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/available_parameter.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_multi_query_progress_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_multi_query_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_query_cancel_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_query_progress_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_query_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_query_state.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/case_statement_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/case_statement_item.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/certificate_action.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/certificate_file_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/certificate_state.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/certificate_status.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/certificate_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/column.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/column_info.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/column_state_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/condition_attributes.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/convert_to_view_data.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/cursor_position.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/dashboard_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/data_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/date_parameters.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/design_join_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/error_highlight_item.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/error_highlight_request.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/error_highlight_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/expression_with_alias.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/feedback_event_args.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/feedback_level.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/field_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/field_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/file_reader_builder_def.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/file_reader_builder_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/filter_model.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/filter_term_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/filter_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/id_selector_definition.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/inlined_property_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/inlined_property_item.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/intellisense_item.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/intellisense_request.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/intellisense_response.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/intellisense_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/joined_table_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/link.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/luminesce_binary_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/lusid_grid_data.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/lusid_problem_details.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/mappable_field.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/mapping_flags.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/multi_query_definition_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/on_clause_term_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/options_csv.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/options_excel.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/options_parquet.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/options_sq_lite.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/options_xml.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/order_by_direction.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/order_by_term_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/query_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/query_designer_binary_operator.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/query_designer_version.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/resource_id.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/resource_list_of_access_controlled_resource.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/scalar_parameter.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/source.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/source_type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/table_meta.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/table_view.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/task_status.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/type.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/view_parameter.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/writer_design.py +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/py.typed +0 -0
- {luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/rest.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: luminesce-sdk
|
|
3
|
-
Version: 2.2.
|
|
3
|
+
Version: 2.2.33
|
|
4
4
|
Summary: FINBOURNE Luminesce Web API
|
|
5
5
|
Home-page: https://github.com/finbourne/luminesce-sdk-python
|
|
6
6
|
License: MIT
|
|
@@ -60,7 +60,8 @@ Class | Method | HTTP request | Description
|
|
|
60
60
|
*SqlBackgroundExecutionApi* | [**fetch_query_result_pipe**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_pipe) | **GET** /api/SqlBackground/{executionId}/pipe | FetchQueryResultPipe: Fetch the result of a query as pipe-delimited
|
|
61
61
|
*SqlBackgroundExecutionApi* | [**fetch_query_result_sqlite**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_sqlite) | **GET** /api/SqlBackground/{executionId}/sqlite | FetchQueryResultSqlite: Fetch the result of a query as SqLite
|
|
62
62
|
*SqlBackgroundExecutionApi* | [**fetch_query_result_xml**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_xml) | **GET** /api/SqlBackground/{executionId}/xml | FetchQueryResultXml: Fetch the result of a query as XML
|
|
63
|
-
*SqlBackgroundExecutionApi* | [**
|
|
63
|
+
*SqlBackgroundExecutionApi* | [**get_historical_feedback**](docs/SqlBackgroundExecutionApi.md#get_historical_feedback) | **GET** /api/SqlBackground/{executionId}/historicalFeedback | GetHistoricalFeedback: View query progress up to this point
|
|
64
|
+
*SqlBackgroundExecutionApi* | [**get_progress_of**](docs/SqlBackgroundExecutionApi.md#get_progress_of) | **GET** /api/SqlBackground/{executionId} | GetProgressOf: View query progress up to this point.
|
|
64
65
|
*SqlBackgroundExecutionApi* | [**start_query**](docs/SqlBackgroundExecutionApi.md#start_query) | **PUT** /api/SqlBackground | StartQuery: Start to Execute Sql in the background
|
|
65
66
|
*SqlDesignApi* | [**get_provider_template_for_export**](docs/SqlDesignApi.md#get_provider_template_for_export) | **GET** /api/Sql/providertemplateforexport | GetProviderTemplateForExport: Makes a fields template for file importing via a writer
|
|
66
67
|
*SqlDesignApi* | [**put_case_statement_design_sql_to_design**](docs/SqlDesignApi.md#put_case_statement_design_sql_to_design) | **PUT** /api/Sql/tocasestatementdesign | PutCaseStatementDesignSqlToDesign: Convert SQL to a case statement design object
|
|
@@ -33,7 +33,8 @@ Class | Method | HTTP request | Description
|
|
|
33
33
|
*SqlBackgroundExecutionApi* | [**fetch_query_result_pipe**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_pipe) | **GET** /api/SqlBackground/{executionId}/pipe | FetchQueryResultPipe: Fetch the result of a query as pipe-delimited
|
|
34
34
|
*SqlBackgroundExecutionApi* | [**fetch_query_result_sqlite**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_sqlite) | **GET** /api/SqlBackground/{executionId}/sqlite | FetchQueryResultSqlite: Fetch the result of a query as SqLite
|
|
35
35
|
*SqlBackgroundExecutionApi* | [**fetch_query_result_xml**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_xml) | **GET** /api/SqlBackground/{executionId}/xml | FetchQueryResultXml: Fetch the result of a query as XML
|
|
36
|
-
*SqlBackgroundExecutionApi* | [**
|
|
36
|
+
*SqlBackgroundExecutionApi* | [**get_historical_feedback**](docs/SqlBackgroundExecutionApi.md#get_historical_feedback) | **GET** /api/SqlBackground/{executionId}/historicalFeedback | GetHistoricalFeedback: View query progress up to this point
|
|
37
|
+
*SqlBackgroundExecutionApi* | [**get_progress_of**](docs/SqlBackgroundExecutionApi.md#get_progress_of) | **GET** /api/SqlBackground/{executionId} | GetProgressOf: View query progress up to this point.
|
|
37
38
|
*SqlBackgroundExecutionApi* | [**start_query**](docs/SqlBackgroundExecutionApi.md#start_query) | **PUT** /api/SqlBackground | StartQuery: Start to Execute Sql in the background
|
|
38
39
|
*SqlDesignApi* | [**get_provider_template_for_export**](docs/SqlDesignApi.md#get_provider_template_for_export) | **GET** /api/Sql/providertemplateforexport | GetProviderTemplateForExport: Makes a fields template for file importing via a writer
|
|
39
40
|
*SqlDesignApi* | [**put_case_statement_design_sql_to_design**](docs/SqlDesignApi.md#put_case_statement_design_sql_to_design) | **PUT** /api/Sql/tocasestatementdesign | PutCaseStatementDesignSqlToDesign: Convert SQL to a case statement design object
|
|
@@ -68,7 +68,7 @@ class SqlBackgroundExecutionApi:
|
|
|
68
68
|
def cancel_query(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], async_req: Optional[bool]=None, **kwargs) -> Union[BackgroundQueryCancelResponse, Awaitable[BackgroundQueryCancelResponse]]: # noqa: E501
|
|
69
69
|
"""CancelQuery: Cancel / Clear data from a previously run query # noqa: E501
|
|
70
70
|
|
|
71
|
-
Cancel the query (if still running) / clear the data (if already returned) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. # noqa: E501
|
|
71
|
+
Cancel the query (if still running) / clear the data (if already returned) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running or the calling user did not run the query. # noqa: E501
|
|
72
72
|
This method makes a synchronous HTTP request by default. To make an
|
|
73
73
|
asynchronous HTTP request, please pass async_req=True
|
|
74
74
|
|
|
@@ -99,7 +99,7 @@ class SqlBackgroundExecutionApi:
|
|
|
99
99
|
def cancel_query_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], **kwargs) -> ApiResponse: # noqa: E501
|
|
100
100
|
"""CancelQuery: Cancel / Clear data from a previously run query # noqa: E501
|
|
101
101
|
|
|
102
|
-
Cancel the query (if still running) / clear the data (if already returned) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. # noqa: E501
|
|
102
|
+
Cancel the query (if still running) / clear the data (if already returned) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running or the calling user did not run the query. # noqa: E501
|
|
103
103
|
This method makes a synchronous HTTP request by default. To make an
|
|
104
104
|
asynchronous HTTP request, please pass async_req=True
|
|
105
105
|
|
|
@@ -219,7 +219,7 @@ class SqlBackgroundExecutionApi:
|
|
|
219
219
|
def fetch_query_result_csv(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, delimiter : Annotated[Optional[StrictStr], Field( description="Delimiter string to override the default")] = None, escape : Annotated[Optional[StrictStr], Field( description="Escape character to override the default")] = None, date_time_format : Annotated[Optional[StrictStr], Field( description="Format to apply for DateTime data, leaving blank gives the Luminesce Exporter default, currently `yyyy-MM-dd HH:mm:ss.fff`")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]: # noqa: E501
|
|
220
220
|
"""FetchQueryResultCsv: Fetch the result of a query as CSV # noqa: E501
|
|
221
221
|
|
|
222
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
222
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
223
223
|
This method makes a synchronous HTTP request by default. To make an
|
|
224
224
|
asynchronous HTTP request, please pass async_req=True
|
|
225
225
|
|
|
@@ -272,7 +272,7 @@ class SqlBackgroundExecutionApi:
|
|
|
272
272
|
def fetch_query_result_csv_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, delimiter : Annotated[Optional[StrictStr], Field( description="Delimiter string to override the default")] = None, escape : Annotated[Optional[StrictStr], Field( description="Escape character to override the default")] = None, date_time_format : Annotated[Optional[StrictStr], Field( description="Format to apply for DateTime data, leaving blank gives the Luminesce Exporter default, currently `yyyy-MM-dd HH:mm:ss.fff`")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
273
273
|
"""FetchQueryResultCsv: Fetch the result of a query as CSV # noqa: E501
|
|
274
274
|
|
|
275
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
275
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
276
276
|
This method makes a synchronous HTTP request by default. To make an
|
|
277
277
|
asynchronous HTTP request, please pass async_req=True
|
|
278
278
|
|
|
@@ -460,7 +460,7 @@ class SqlBackgroundExecutionApi:
|
|
|
460
460
|
def fetch_query_result_excel(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, date_time_format : Annotated[Optional[StrictStr], Field( description="Format to apply for DateTime data, leaving blank gives the Luminesce Exporter default, currently `yyyy-MM-dd HH:mm:ss.fff`")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[bytearray, Awaitable[bytearray]]: # noqa: E501
|
|
461
461
|
"""FetchQueryResultExcel: Fetch the result of a query as an Excel file # noqa: E501
|
|
462
462
|
|
|
463
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
463
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
464
464
|
This method makes a synchronous HTTP request by default. To make an
|
|
465
465
|
asynchronous HTTP request, please pass async_req=True
|
|
466
466
|
|
|
@@ -503,7 +503,7 @@ class SqlBackgroundExecutionApi:
|
|
|
503
503
|
def fetch_query_result_excel_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, date_time_format : Annotated[Optional[StrictStr], Field( description="Format to apply for DateTime data, leaving blank gives the Luminesce Exporter default, currently `yyyy-MM-dd HH:mm:ss.fff`")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
504
504
|
"""FetchQueryResultExcel: Fetch the result of a query as an Excel file # noqa: E501
|
|
505
505
|
|
|
506
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
506
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
507
507
|
This method makes a synchronous HTTP request by default. To make an
|
|
508
508
|
asynchronous HTTP request, please pass async_req=True
|
|
509
509
|
|
|
@@ -661,7 +661,7 @@ class SqlBackgroundExecutionApi:
|
|
|
661
661
|
def fetch_query_result_histogram(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], timestamp_field_name : Annotated[StrictStr, Field(..., description="Name of the timestamp field used in building the histogram")], start_at : Annotated[Optional[datetime], Field(description="Start point (of the timestampFieldName field) for the histogram")] = None, end_at : Annotated[Optional[datetime], Field(description="End point (of the timestampFieldName field) for the histogram")] = None, bucket_size : Annotated[Optional[StrictStr], Field( description="Optional histogram bucket width. If not provided a set number of buckets between start/end range will be generated.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, json_proper : Annotated[Optional[StrictBool], Field(description="Should this be text/json (not json-encoded-as-a-string)")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]: # noqa: E501
|
|
662
662
|
"""FetchQueryResultHistogram: Construct a histogram of the result of a query # noqa: E501
|
|
663
663
|
|
|
664
|
-
Fetch the histogram in Json format (if available, or if not simply being informed it is not yet ready) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
664
|
+
Fetch the histogram in Json format (if available, or if not simply being informed it is not yet ready) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
665
665
|
This method makes a synchronous HTTP request by default. To make an
|
|
666
666
|
asynchronous HTTP request, please pass async_req=True
|
|
667
667
|
|
|
@@ -704,7 +704,7 @@ class SqlBackgroundExecutionApi:
|
|
|
704
704
|
def fetch_query_result_histogram_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], timestamp_field_name : Annotated[StrictStr, Field(..., description="Name of the timestamp field used in building the histogram")], start_at : Annotated[Optional[datetime], Field(description="Start point (of the timestampFieldName field) for the histogram")] = None, end_at : Annotated[Optional[datetime], Field(description="End point (of the timestampFieldName field) for the histogram")] = None, bucket_size : Annotated[Optional[StrictStr], Field( description="Optional histogram bucket width. If not provided a set number of buckets between start/end range will be generated.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, json_proper : Annotated[Optional[StrictBool], Field(description="Should this be text/json (not json-encoded-as-a-string)")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
705
705
|
"""FetchQueryResultHistogram: Construct a histogram of the result of a query # noqa: E501
|
|
706
706
|
|
|
707
|
-
Fetch the histogram in Json format (if available, or if not simply being informed it is not yet ready) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
707
|
+
Fetch the histogram in Json format (if available, or if not simply being informed it is not yet ready) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
708
708
|
This method makes a synchronous HTTP request by default. To make an
|
|
709
709
|
asynchronous HTTP request, please pass async_req=True
|
|
710
710
|
|
|
@@ -868,7 +868,7 @@ class SqlBackgroundExecutionApi:
|
|
|
868
868
|
def fetch_query_result_json(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]: # noqa: E501
|
|
869
869
|
"""FetchQueryResultJson: Fetch the result of a query as a JSON string # noqa: E501
|
|
870
870
|
|
|
871
|
-
*Please move to '/jsonProper' instead. This may be marked as Deprecated in the future.* Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
871
|
+
*Please move to '/jsonProper' instead. This may be marked as Deprecated in the future.* Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
872
872
|
This method makes a synchronous HTTP request by default. To make an
|
|
873
873
|
asynchronous HTTP request, please pass async_req=True
|
|
874
874
|
|
|
@@ -913,7 +913,7 @@ class SqlBackgroundExecutionApi:
|
|
|
913
913
|
def fetch_query_result_json_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
914
914
|
"""FetchQueryResultJson: Fetch the result of a query as a JSON string # noqa: E501
|
|
915
915
|
|
|
916
|
-
*Please move to '/jsonProper' instead. This may be marked as Deprecated in the future.* Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
916
|
+
*Please move to '/jsonProper' instead. This may be marked as Deprecated in the future.* Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
917
917
|
This method makes a synchronous HTTP request by default. To make an
|
|
918
918
|
asynchronous HTTP request, please pass async_req=True
|
|
919
919
|
|
|
@@ -1077,7 +1077,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1077
1077
|
def fetch_query_result_json_proper(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]: # noqa: E501
|
|
1078
1078
|
"""FetchQueryResultJsonProper: Fetch the result of a query as JSON # noqa: E501
|
|
1079
1079
|
|
|
1080
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1080
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1081
1081
|
This method makes a synchronous HTTP request by default. To make an
|
|
1082
1082
|
asynchronous HTTP request, please pass async_req=True
|
|
1083
1083
|
|
|
@@ -1124,7 +1124,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1124
1124
|
def fetch_query_result_json_proper_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1125
1125
|
"""FetchQueryResultJsonProper: Fetch the result of a query as JSON # noqa: E501
|
|
1126
1126
|
|
|
1127
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1127
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1128
1128
|
This method makes a synchronous HTTP request by default. To make an
|
|
1129
1129
|
asynchronous HTTP request, please pass async_req=True
|
|
1130
1130
|
|
|
@@ -1294,7 +1294,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1294
1294
|
def fetch_query_result_parquet(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[bytearray, Awaitable[bytearray]]: # noqa: E501
|
|
1295
1295
|
"""FetchQueryResultParquet: Fetch the result of a query as Parquet # noqa: E501
|
|
1296
1296
|
|
|
1297
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1297
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1298
1298
|
This method makes a synchronous HTTP request by default. To make an
|
|
1299
1299
|
asynchronous HTTP request, please pass async_req=True
|
|
1300
1300
|
|
|
@@ -1335,7 +1335,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1335
1335
|
def fetch_query_result_parquet_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1336
1336
|
"""FetchQueryResultParquet: Fetch the result of a query as Parquet # noqa: E501
|
|
1337
1337
|
|
|
1338
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1338
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1339
1339
|
This method makes a synchronous HTTP request by default. To make an
|
|
1340
1340
|
asynchronous HTTP request, please pass async_req=True
|
|
1341
1341
|
|
|
@@ -1487,7 +1487,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1487
1487
|
def fetch_query_result_pipe(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, date_time_format : Annotated[Optional[StrictStr], Field( description="Format to apply for DateTime data, leaving blank gives the Luminesce Exporter default, currently `yyyy-MM-dd HH:mm:ss.fff`")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]: # noqa: E501
|
|
1488
1488
|
"""FetchQueryResultPipe: Fetch the result of a query as pipe-delimited # noqa: E501
|
|
1489
1489
|
|
|
1490
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1490
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1491
1491
|
This method makes a synchronous HTTP request by default. To make an
|
|
1492
1492
|
asynchronous HTTP request, please pass async_req=True
|
|
1493
1493
|
|
|
@@ -1536,7 +1536,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1536
1536
|
def fetch_query_result_pipe_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, date_time_format : Annotated[Optional[StrictStr], Field( description="Format to apply for DateTime data, leaving blank gives the Luminesce Exporter default, currently `yyyy-MM-dd HH:mm:ss.fff`")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1537
1537
|
"""FetchQueryResultPipe: Fetch the result of a query as pipe-delimited # noqa: E501
|
|
1538
1538
|
|
|
1539
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1539
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1540
1540
|
This method makes a synchronous HTTP request by default. To make an
|
|
1541
1541
|
asynchronous HTTP request, please pass async_req=True
|
|
1542
1542
|
|
|
@@ -1712,7 +1712,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1712
1712
|
def fetch_query_result_sqlite(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[bytearray, Awaitable[bytearray]]: # noqa: E501
|
|
1713
1713
|
"""FetchQueryResultSqlite: Fetch the result of a query as SqLite # noqa: E501
|
|
1714
1714
|
|
|
1715
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1715
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1716
1716
|
This method makes a synchronous HTTP request by default. To make an
|
|
1717
1717
|
asynchronous HTTP request, please pass async_req=True
|
|
1718
1718
|
|
|
@@ -1753,7 +1753,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1753
1753
|
def fetch_query_result_sqlite_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1754
1754
|
"""FetchQueryResultSqlite: Fetch the result of a query as SqLite # noqa: E501
|
|
1755
1755
|
|
|
1756
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1756
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1757
1757
|
This method makes a synchronous HTTP request by default. To make an
|
|
1758
1758
|
asynchronous HTTP request, please pass async_req=True
|
|
1759
1759
|
|
|
@@ -1905,7 +1905,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1905
1905
|
def fetch_query_result_xml(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]: # noqa: E501
|
|
1906
1906
|
"""FetchQueryResultXml: Fetch the result of a query as XML # noqa: E501
|
|
1907
1907
|
|
|
1908
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1908
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1909
1909
|
This method makes a synchronous HTTP request by default. To make an
|
|
1910
1910
|
asynchronous HTTP request, please pass async_req=True
|
|
1911
1911
|
|
|
@@ -1952,7 +1952,7 @@ class SqlBackgroundExecutionApi:
|
|
|
1952
1952
|
def fetch_query_result_xml_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], download : Annotated[Optional[StrictBool], Field(description="Makes this a file-download request (as opposed to returning the data in the response-body)")] = None, sort_by : Annotated[Optional[StrictStr], Field( description="Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself.")] = None, filter : Annotated[Optional[StrictStr], Field( description="An ODATA filter per Finbourne.Filtering syntax.")] = None, select : Annotated[Optional[StrictStr], Field( description="Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also.")] = None, group_by : Annotated[Optional[StrictStr], Field( description="Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter.")] = None, limit : Annotated[Optional[StrictInt], Field(description="When paginating, only return this number of records, page should also be specified.")] = None, page : Annotated[Optional[StrictInt], Field(description="0-N based on chunk sized determined by the limit, ignored if limit < 1.")] = None, load_wait_milliseconds : Annotated[Optional[StrictInt], Field(description="Optional maximum additional wait period for post execution platform processing.")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
1953
1953
|
"""FetchQueryResultXml: Fetch the result of a query as XML # noqa: E501
|
|
1954
1954
|
|
|
1955
|
-
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1955
|
+
Fetch the data in the format of the method's name (if available, or if not simply being informed it is not yet ready). The following error codes are to be anticipated most with standard Problem Detail reports: - 400 BadRequest : Something failed with the execution of your query - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
1956
1956
|
This method makes a synchronous HTTP request by default. To make an
|
|
1957
1957
|
asynchronous HTTP request, please pass async_req=True
|
|
1958
1958
|
|
|
@@ -2110,6 +2110,157 @@ class SqlBackgroundExecutionApi:
|
|
|
2110
2110
|
_request_auth=_params.get('_request_auth'))
|
|
2111
2111
|
|
|
2112
2112
|
|
|
2113
|
+
@overload
|
|
2114
|
+
async def get_historical_feedback(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], **kwargs) -> BackgroundQueryProgressResponse: # noqa: E501
|
|
2115
|
+
...
|
|
2116
|
+
|
|
2117
|
+
@overload
|
|
2118
|
+
def get_historical_feedback(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], async_req: Optional[bool]=True, **kwargs) -> BackgroundQueryProgressResponse: # noqa: E501
|
|
2119
|
+
...
|
|
2120
|
+
|
|
2121
|
+
@validate_arguments
|
|
2122
|
+
def get_historical_feedback(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], async_req: Optional[bool]=None, **kwargs) -> Union[BackgroundQueryProgressResponse, Awaitable[BackgroundQueryProgressResponse]]: # noqa: E501
|
|
2123
|
+
"""GetHistoricalFeedback: View query progress up to this point # noqa: E501
|
|
2124
|
+
|
|
2125
|
+
View full progress information, including historical feedback for queries which have passed their `keepForSeconds` time, so long as they were executed in the last 31 days. Unlike most methods here this may be called by a user that did not run the original query, as this is pure telemetry information. The following error codes are to be anticipated most with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
2126
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2127
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2128
|
+
|
|
2129
|
+
>>> thread = api.get_historical_feedback(execution_id, async_req=True)
|
|
2130
|
+
>>> result = thread.get()
|
|
2131
|
+
|
|
2132
|
+
:param execution_id: ExecutionId returned when starting the query (required)
|
|
2133
|
+
:type execution_id: str
|
|
2134
|
+
:param async_req: Whether to execute the request asynchronously.
|
|
2135
|
+
:type async_req: bool, optional
|
|
2136
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
2137
|
+
:param opts: Configuration options for this request
|
|
2138
|
+
:type opts: ConfigurationOptions, optional
|
|
2139
|
+
:return: Returns the result object.
|
|
2140
|
+
If the method is called asynchronously,
|
|
2141
|
+
returns the request thread.
|
|
2142
|
+
:rtype: BackgroundQueryProgressResponse
|
|
2143
|
+
"""
|
|
2144
|
+
kwargs['_return_http_data_only'] = True
|
|
2145
|
+
if '_preload_content' in kwargs:
|
|
2146
|
+
message = "Error! Please call the get_historical_feedback_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
|
2147
|
+
raise ValueError(message)
|
|
2148
|
+
if async_req is not None:
|
|
2149
|
+
kwargs['async_req'] = async_req
|
|
2150
|
+
return self.get_historical_feedback_with_http_info(execution_id, **kwargs) # noqa: E501
|
|
2151
|
+
|
|
2152
|
+
@validate_arguments
|
|
2153
|
+
def get_historical_feedback_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], **kwargs) -> ApiResponse: # noqa: E501
|
|
2154
|
+
"""GetHistoricalFeedback: View query progress up to this point # noqa: E501
|
|
2155
|
+
|
|
2156
|
+
View full progress information, including historical feedback for queries which have passed their `keepForSeconds` time, so long as they were executed in the last 31 days. Unlike most methods here this may be called by a user that did not run the original query, as this is pure telemetry information. The following error codes are to be anticipated most with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
2157
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2158
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2159
|
+
|
|
2160
|
+
>>> thread = api.get_historical_feedback_with_http_info(execution_id, async_req=True)
|
|
2161
|
+
>>> result = thread.get()
|
|
2162
|
+
|
|
2163
|
+
:param execution_id: ExecutionId returned when starting the query (required)
|
|
2164
|
+
:type execution_id: str
|
|
2165
|
+
:param async_req: Whether to execute the request asynchronously.
|
|
2166
|
+
:type async_req: bool, optional
|
|
2167
|
+
:param _preload_content: if False, the ApiResponse.data will
|
|
2168
|
+
be set to none and raw_data will store the
|
|
2169
|
+
HTTP response body without reading/decoding.
|
|
2170
|
+
Default is True.
|
|
2171
|
+
:type _preload_content: bool, optional
|
|
2172
|
+
:param _return_http_data_only: response data instead of ApiResponse
|
|
2173
|
+
object with status code, headers, etc
|
|
2174
|
+
:type _return_http_data_only: bool, optional
|
|
2175
|
+
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
|
|
2176
|
+
:param opts: Configuration options for this request
|
|
2177
|
+
:type opts: ConfigurationOptions, optional
|
|
2178
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
2179
|
+
request; this effectively ignores the authentication
|
|
2180
|
+
in the spec for a single request.
|
|
2181
|
+
:type _request_auth: dict, optional
|
|
2182
|
+
:type _content_type: string, optional: force content-type for the request
|
|
2183
|
+
:return: Returns the result object.
|
|
2184
|
+
If the method is called asynchronously,
|
|
2185
|
+
returns the request thread.
|
|
2186
|
+
:rtype: tuple(BackgroundQueryProgressResponse, status_code(int), headers(HTTPHeaderDict))
|
|
2187
|
+
"""
|
|
2188
|
+
|
|
2189
|
+
_params = locals()
|
|
2190
|
+
|
|
2191
|
+
_all_params = [
|
|
2192
|
+
'execution_id'
|
|
2193
|
+
]
|
|
2194
|
+
_all_params.extend(
|
|
2195
|
+
[
|
|
2196
|
+
'async_req',
|
|
2197
|
+
'_return_http_data_only',
|
|
2198
|
+
'_preload_content',
|
|
2199
|
+
'_request_timeout',
|
|
2200
|
+
'_request_auth',
|
|
2201
|
+
'_content_type',
|
|
2202
|
+
'_headers',
|
|
2203
|
+
'opts'
|
|
2204
|
+
]
|
|
2205
|
+
)
|
|
2206
|
+
|
|
2207
|
+
# validate the arguments
|
|
2208
|
+
for _key, _val in _params['kwargs'].items():
|
|
2209
|
+
if _key not in _all_params:
|
|
2210
|
+
raise ApiTypeError(
|
|
2211
|
+
"Got an unexpected keyword argument '%s'"
|
|
2212
|
+
" to method get_historical_feedback" % _key
|
|
2213
|
+
)
|
|
2214
|
+
_params[_key] = _val
|
|
2215
|
+
del _params['kwargs']
|
|
2216
|
+
|
|
2217
|
+
_collection_formats = {}
|
|
2218
|
+
|
|
2219
|
+
# process the path parameters
|
|
2220
|
+
_path_params = {}
|
|
2221
|
+
if _params['execution_id']:
|
|
2222
|
+
_path_params['executionId'] = _params['execution_id']
|
|
2223
|
+
|
|
2224
|
+
|
|
2225
|
+
# process the query parameters
|
|
2226
|
+
_query_params = []
|
|
2227
|
+
# process the header parameters
|
|
2228
|
+
_header_params = dict(_params.get('_headers', {}))
|
|
2229
|
+
# process the form parameters
|
|
2230
|
+
_form_params = []
|
|
2231
|
+
_files = {}
|
|
2232
|
+
# process the body parameter
|
|
2233
|
+
_body_params = None
|
|
2234
|
+
# set the HTTP header `Accept`
|
|
2235
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
2236
|
+
['text/plain', 'application/json', 'text/json']) # noqa: E501
|
|
2237
|
+
|
|
2238
|
+
# authentication setting
|
|
2239
|
+
_auth_settings = ['oauth2'] # noqa: E501
|
|
2240
|
+
|
|
2241
|
+
_response_types_map = {
|
|
2242
|
+
'200': "BackgroundQueryProgressResponse",
|
|
2243
|
+
}
|
|
2244
|
+
|
|
2245
|
+
return self.api_client.call_api(
|
|
2246
|
+
'/api/SqlBackground/{executionId}/historicalFeedback', 'GET',
|
|
2247
|
+
_path_params,
|
|
2248
|
+
_query_params,
|
|
2249
|
+
_header_params,
|
|
2250
|
+
body=_body_params,
|
|
2251
|
+
post_params=_form_params,
|
|
2252
|
+
files=_files,
|
|
2253
|
+
response_types_map=_response_types_map,
|
|
2254
|
+
auth_settings=_auth_settings,
|
|
2255
|
+
async_req=_params.get('async_req'),
|
|
2256
|
+
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
|
2257
|
+
_preload_content=_params.get('_preload_content', True),
|
|
2258
|
+
_request_timeout=_params.get('_request_timeout'),
|
|
2259
|
+
opts=_params.get('opts'),
|
|
2260
|
+
collection_formats=_collection_formats,
|
|
2261
|
+
_request_auth=_params.get('_request_auth'))
|
|
2262
|
+
|
|
2263
|
+
|
|
2113
2264
|
@overload
|
|
2114
2265
|
async def get_progress_of(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], build_from_logs : Annotated[Optional[StrictBool], Field(description="Should the response state be build from query logs if missing from the shared-db-state? Deprecated. Regardless of the value here it is now the case that: False [and now even True] will mean `404 Not Found` in cases where it was a real query but has passed its `keepForSeconds` since the query completed (as well as 'this was not a query at all' of course)")] = None, **kwargs) -> BackgroundQueryProgressResponse: # noqa: E501
|
|
2115
2266
|
...
|
|
@@ -2120,9 +2271,9 @@ class SqlBackgroundExecutionApi:
|
|
|
2120
2271
|
|
|
2121
2272
|
@validate_arguments
|
|
2122
2273
|
def get_progress_of(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], build_from_logs : Annotated[Optional[StrictBool], Field(description="Should the response state be build from query logs if missing from the shared-db-state? Deprecated. Regardless of the value here it is now the case that: False [and now even True] will mean `404 Not Found` in cases where it was a real query but has passed its `keepForSeconds` since the query completed (as well as 'this was not a query at all' of course)")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[BackgroundQueryProgressResponse, Awaitable[BackgroundQueryProgressResponse]]: # noqa: E501
|
|
2123
|
-
"""GetProgressOf: View query progress up to this point # noqa: E501
|
|
2274
|
+
"""GetProgressOf: View query progress up to this point. # noqa: E501
|
|
2124
2275
|
|
|
2125
|
-
View progress information (up until this point and starting from the last point requested) The following error codes are to be anticipated most with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
2276
|
+
View progress information (up until this point and starting from the last point requested) The following error codes are to be anticipated most with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
2126
2277
|
This method makes a synchronous HTTP request by default. To make an
|
|
2127
2278
|
asynchronous HTTP request, please pass async_req=True
|
|
2128
2279
|
|
|
@@ -2153,9 +2304,9 @@ class SqlBackgroundExecutionApi:
|
|
|
2153
2304
|
|
|
2154
2305
|
@validate_arguments
|
|
2155
2306
|
def get_progress_of_with_http_info(self, execution_id : Annotated[StrictStr, Field(..., description="ExecutionId returned when starting the query")], build_from_logs : Annotated[Optional[StrictBool], Field(description="Should the response state be build from query logs if missing from the shared-db-state? Deprecated. Regardless of the value here it is now the case that: False [and now even True] will mean `404 Not Found` in cases where it was a real query but has passed its `keepForSeconds` since the query completed (as well as 'this was not a query at all' of course)")] = None, **kwargs) -> ApiResponse: # noqa: E501
|
|
2156
|
-
"""GetProgressOf: View query progress up to this point # noqa: E501
|
|
2307
|
+
"""GetProgressOf: View query progress up to this point. # noqa: E501
|
|
2157
2308
|
|
|
2158
|
-
View progress information (up until this point and starting from the last point requested) The following error codes are to be anticipated most with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
2309
|
+
View progress information (up until this point and starting from the last point requested) The following error codes are to be anticipated most with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running or the calling user did not run the query. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request. # noqa: E501
|
|
2159
2310
|
This method makes a synchronous HTTP request by default. To make an
|
|
2160
2311
|
asynchronous HTTP request, please pass async_req=True
|
|
2161
2312
|
|
|
@@ -445,7 +445,7 @@ class Configuration:
|
|
|
445
445
|
return "Python SDK Debug Report:\n"\
|
|
446
446
|
"OS: {env}\n"\
|
|
447
447
|
"Python Version: {pyversion}\n"\
|
|
448
|
-
"Version of the API: 1.18.
|
|
448
|
+
"Version of the API: 1.18.801\n"\
|
|
449
449
|
"SDK Package Version: {package_version}".\
|
|
450
450
|
format(env=sys.platform, pyversion=sys.version, package_version=package_version)
|
|
451
451
|
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/current_table_field_catalog_api.py
RENAMED
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/api/historically_executed_queries_api.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/extensions/tcp_keep_alive_connector.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/access_controlled_resource.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_multi_query_response.py
RENAMED
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_query_cancel_response.py
RENAMED
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/background_query_progress_response.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/file_reader_builder_response.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/multi_query_definition_type.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{luminesce_sdk-2.2.31 → luminesce_sdk-2.2.33}/luminesce/models/query_designer_binary_operator.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|