luminesce-sdk 2.4.4__tar.gz → 2.4.9__tar.gz

{luminesce_sdk-2.4.4 → luminesce_sdk-2.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luminesce-sdk
-Version: 2.4.4
+Version: 2.4.9
 Summary: FINBOURNE Luminesce Web API
 License: MIT
 Keywords: OpenAPI,OpenAPI-Generator,FINBOURNE Luminesce Web API,luminesce-sdk
@@ -53,6 +53,7 @@ Class | Method | HTTP request | Description
 *SqlBackgroundExecutionApi* | [**fetch_query_result_histogram**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_histogram) | **GET** /api/SqlBackground/{executionId}/histogram | FetchQueryResultHistogram: Construct a histogram of the result of a query
 *SqlBackgroundExecutionApi* | [**fetch_query_result_json**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json) | **GET** /api/SqlBackground/{executionId}/json | FetchQueryResultJson: Fetch the result of a query as a JSON string
 *SqlBackgroundExecutionApi* | [**fetch_query_result_json_proper**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json_proper) | **GET** /api/SqlBackground/{executionId}/jsonProper | FetchQueryResultJsonProper: Fetch the result of a query as JSON
+*SqlBackgroundExecutionApi* | [**fetch_query_result_json_proper_with_lineage**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json_proper_with_lineage) | **GET** /api/SqlBackground/{executionId}/jsonProperWithLineage | FetchQueryResultJsonProperWithLineage: Fetch the result of a query as JSON, but including a Lineage Node (if available)
 *SqlBackgroundExecutionApi* | [**fetch_query_result_parquet**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_parquet) | **GET** /api/SqlBackground/{executionId}/parquet | FetchQueryResultParquet: Fetch the result of a query as Parquet
 *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
 *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
@@ -150,6 +151,7 @@ Class | Method | HTTP request | Description
  - [IntellisenseResponse](docs/IntellisenseResponse.md)
  - [IntellisenseType](docs/IntellisenseType.md)
  - [JoinedTableDesign](docs/JoinedTableDesign.md)
+ - [Lineage](docs/Lineage.md)
  - [Link](docs/Link.md)
  - [LuminesceBinaryType](docs/LuminesceBinaryType.md)
  - [LusidGridData](docs/LusidGridData.md)
@@ -173,6 +175,8 @@ Class | Method | HTTP request | Description
  - [ScalarParameter](docs/ScalarParameter.md)
  - [Source](docs/Source.md)
  - [SourceType](docs/SourceType.md)
+ - [SqlExecutionFlags](docs/SqlExecutionFlags.md)
+ - [TableLineage](docs/TableLineage.md)
  - [TableMeta](docs/TableMeta.md)
  - [TableView](docs/TableView.md)
  - [TaskStatus](docs/TaskStatus.md)

{luminesce_sdk-2.4.4 → luminesce_sdk-2.4.9}/README.md

@@ -29,6 +29,7 @@ Class | Method | HTTP request | Description
 *SqlBackgroundExecutionApi* | [**fetch_query_result_histogram**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_histogram) | **GET** /api/SqlBackground/{executionId}/histogram | FetchQueryResultHistogram: Construct a histogram of the result of a query
 *SqlBackgroundExecutionApi* | [**fetch_query_result_json**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json) | **GET** /api/SqlBackground/{executionId}/json | FetchQueryResultJson: Fetch the result of a query as a JSON string
 *SqlBackgroundExecutionApi* | [**fetch_query_result_json_proper**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json_proper) | **GET** /api/SqlBackground/{executionId}/jsonProper | FetchQueryResultJsonProper: Fetch the result of a query as JSON
+*SqlBackgroundExecutionApi* | [**fetch_query_result_json_proper_with_lineage**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_json_proper_with_lineage) | **GET** /api/SqlBackground/{executionId}/jsonProperWithLineage | FetchQueryResultJsonProperWithLineage: Fetch the result of a query as JSON, but including a Lineage Node (if available)
 *SqlBackgroundExecutionApi* | [**fetch_query_result_parquet**](docs/SqlBackgroundExecutionApi.md#fetch_query_result_parquet) | **GET** /api/SqlBackground/{executionId}/parquet | FetchQueryResultParquet: Fetch the result of a query as Parquet
 *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
 *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
@@ -126,6 +127,7 @@ Class | Method | HTTP request | Description
  - [IntellisenseResponse](docs/IntellisenseResponse.md)
  - [IntellisenseType](docs/IntellisenseType.md)
  - [JoinedTableDesign](docs/JoinedTableDesign.md)
+ - [Lineage](docs/Lineage.md)
  - [Link](docs/Link.md)
  - [LuminesceBinaryType](docs/LuminesceBinaryType.md)
  - [LusidGridData](docs/LusidGridData.md)
@@ -149,6 +151,8 @@ Class | Method | HTTP request | Description
  - [ScalarParameter](docs/ScalarParameter.md)
  - [Source](docs/Source.md)
  - [SourceType](docs/SourceType.md)
+ - [SqlExecutionFlags](docs/SqlExecutionFlags.md)
+ - [TableLineage](docs/TableLineage.md)
  - [TableMeta](docs/TableMeta.md)
  - [TableView](docs/TableView.md)
  - [TaskStatus](docs/TaskStatus.md)

{luminesce_sdk-2.4.4 → luminesce_sdk-2.4.9}/luminesce/__init__.py

@@ -90,6 +90,7 @@ from luminesce.models.intellisense_request import IntellisenseRequest
 from luminesce.models.intellisense_response import IntellisenseResponse
 from luminesce.models.intellisense_type import IntellisenseType
 from luminesce.models.joined_table_design import JoinedTableDesign
+from luminesce.models.lineage import Lineage
 from luminesce.models.link import Link
 from luminesce.models.luminesce_binary_type import LuminesceBinaryType
 from luminesce.models.lusid_grid_data import LusidGridData
@@ -113,6 +114,8 @@ from luminesce.models.resource_list_of_access_controlled_resource import Resourc
 from luminesce.models.scalar_parameter import ScalarParameter
 from luminesce.models.source import Source
 from luminesce.models.source_type import SourceType
+from luminesce.models.sql_execution_flags import SqlExecutionFlags
+from luminesce.models.table_lineage import TableLineage
 from luminesce.models.table_meta import TableMeta
 from luminesce.models.table_view import TableView
 from luminesce.models.task_status import TaskStatus
@@ -197,6 +200,7 @@ __all__ = [
     "IntellisenseResponse",
     "IntellisenseType",
     "JoinedTableDesign",
+    "Lineage",
     "Link",
     "LuminesceBinaryType",
     "LusidGridData",
@@ -220,6 +224,8 @@ __all__ = [
     "ScalarParameter",
     "Source",
     "SourceType",
+    "SqlExecutionFlags",
+    "TableLineage",
     "TableMeta",
     "TableView",
     "TaskStatus",

{luminesce_sdk-2.4.4 → luminesce_sdk-2.4.9}/luminesce/api/current_table_field_catalog_api.py

@@ -209,26 +209,28 @@ class CurrentTableFieldCatalogApi:
 
 
     @overload
-    async def get_fields(self, table_like : Annotated[Optional[StrictStr], Field()] = None, **kwargs) -> str:  # noqa: E501
+    async def get_fields(self, table_like : Annotated[Optional[StrictStr], Field( description="Allows for SQL-LIKE style filtering of which Providers you want the fields for.")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, **kwargs) -> str:  # noqa: E501
         ...
 
     @overload
-    def get_fields(self, table_like : Annotated[Optional[StrictStr], Field()] = None, async_req: Optional[bool]=True, **kwargs) -> str:  # noqa: E501
+    def get_fields(self, table_like : Annotated[Optional[StrictStr], Field( description="Allows for SQL-LIKE style filtering of which Providers you want the fields for.")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, async_req: Optional[bool]=True, **kwargs) -> str:  # noqa: E501
         ...
 
     @validate_arguments
-    def get_fields(self, table_like : Annotated[Optional[StrictStr], Field()] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]:  # noqa: E501
+    def get_fields(self, table_like : Annotated[Optional[StrictStr], Field( description="Allows for SQL-LIKE style filtering of which Providers you want the fields for.")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]:  # noqa: E501
         """GetFields: List field and parameters for providers  # noqa: E501
 
          Returns the User's full version of the catalog but only the field/parameter-level information  (as well as the TableName they refer to, of course) for tables matching the `tableLike` (manually include wildcards if desired).  The internal results are cached for several minutes.  It is possible to be throttled if you make too many requests in a short period of time, receiving a: - 429 Too Many Requests : Please try your request again soon  The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_fields(table_like, async_req=True)
+        >>> thread = api.get_fields(table_like, add_lineage, async_req=True)
         >>> result = thread.get()
 
-        :param table_like:
+        :param table_like: Allows for SQL-LIKE style filtering of which Providers you want the fields for.
         :type table_like: str
+        :param add_lineage: Adds in any column lineage which is registered in the catalog to the results.
+        :type add_lineage: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
@@ -245,21 +247,23 @@ class CurrentTableFieldCatalogApi:
             raise ValueError(message)
         if async_req is not None:
             kwargs['async_req'] = async_req
-        return self.get_fields_with_http_info(table_like, **kwargs)  # noqa: E501
+        return self.get_fields_with_http_info(table_like, add_lineage, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def get_fields_with_http_info(self, table_like : Annotated[Optional[StrictStr], Field()] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def get_fields_with_http_info(self, table_like : Annotated[Optional[StrictStr], Field( description="Allows for SQL-LIKE style filtering of which Providers you want the fields for.")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """GetFields: List field and parameters for providers  # noqa: E501
 
          Returns the User's full version of the catalog but only the field/parameter-level information  (as well as the TableName they refer to, of course) for tables matching the `tableLike` (manually include wildcards if desired).  The internal results are cached for several minutes.  It is possible to be throttled if you make too many requests in a short period of time, receiving a: - 429 Too Many Requests : Please try your request again soon  The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_fields_with_http_info(table_like, async_req=True)
+        >>> thread = api.get_fields_with_http_info(table_like, add_lineage, async_req=True)
         >>> result = thread.get()
 
-        :param table_like:
+        :param table_like: Allows for SQL-LIKE style filtering of which Providers you want the fields for.
         :type table_like: str
+        :param add_lineage: Adds in any column lineage which is registered in the catalog to the results.
+        :type add_lineage: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -287,7 +291,8 @@ class CurrentTableFieldCatalogApi:
         _params = locals()
 
         _all_params = [
-            'table_like'
+            'table_like',
+            'add_lineage'
         ]
         _all_params.extend(
             [
@@ -322,6 +327,9 @@ class CurrentTableFieldCatalogApi:
         if _params.get('table_like') is not None:  # noqa: E501
             _query_params.append(('tableLike', _params['table_like']))
 
+        if _params.get('add_lineage') is not None:  # noqa: E501
+            _query_params.append(('addLineage', _params['add_lineage']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters
@@ -360,26 +368,28 @@ class CurrentTableFieldCatalogApi:
 
 
     @overload
-    async def get_providers(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, **kwargs) -> str:  # noqa: E501
+    async def get_providers(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, **kwargs) -> str:  # noqa: E501
         ...
 
     @overload
-    def get_providers(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, async_req: Optional[bool]=True, **kwargs) -> str:  # noqa: E501
+    def get_providers(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, async_req: Optional[bool]=True, **kwargs) -> str:  # noqa: E501
         ...
 
     @validate_arguments
-    def get_providers(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]:  # noqa: E501
+    def get_providers(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[str, Awaitable[str]]:  # noqa: E501
         """GetProviders: List available providers  # noqa: E501
 
          Returns the User's full version of the catalog but only the table/provider-level information they have access to.  The internal results are cached for several minutes.  It is possible to be throttled if you make too many requests in a short period of time, receiving a: - 429 Too Many Requests : Please try your request again soon  The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_providers(free_text_search, async_req=True)
+        >>> thread = api.get_providers(free_text_search, add_lineage, async_req=True)
         >>> result = thread.get()
 
         :param free_text_search: Limit the catalog to only things in some way dealing with the passed in text string
         :type free_text_search: str
+        :param add_lineage: Adds in any column lineage which is registered in the catalog to the results.
+        :type add_lineage: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
@@ -396,21 +406,23 @@ class CurrentTableFieldCatalogApi:
             raise ValueError(message)
         if async_req is not None:
             kwargs['async_req'] = async_req
-        return self.get_providers_with_http_info(free_text_search, **kwargs)  # noqa: E501
+        return self.get_providers_with_http_info(free_text_search, add_lineage, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def get_providers_with_http_info(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def get_providers_with_http_info(self, free_text_search : Annotated[Optional[StrictStr], Field( description="Limit the catalog to only things in some way dealing with the passed in text string")] = None, add_lineage : Annotated[Optional[StrictBool], Field(description="Adds in any column lineage which is registered in the catalog to the results.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """GetProviders: List available providers  # noqa: E501
 
          Returns the User's full version of the catalog but only the table/provider-level information they have access to.  The internal results are cached for several minutes.  It is possible to be throttled if you make too many requests in a short period of time, receiving a: - 429 Too Many Requests : Please try your request again soon  The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_providers_with_http_info(free_text_search, async_req=True)
+        >>> thread = api.get_providers_with_http_info(free_text_search, add_lineage, async_req=True)
         >>> result = thread.get()
 
         :param free_text_search: Limit the catalog to only things in some way dealing with the passed in text string
         :type free_text_search: str
+        :param add_lineage: Adds in any column lineage which is registered in the catalog to the results.
+        :type add_lineage: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -438,7 +450,8 @@ class CurrentTableFieldCatalogApi:
         _params = locals()
 
         _all_params = [
-            'free_text_search'
+            'free_text_search',
+            'add_lineage'
         ]
         _all_params.extend(
             [
@@ -473,6 +486,9 @@ class CurrentTableFieldCatalogApi:
         if _params.get('free_text_search') is not None:  # noqa: E501
             _query_params.append(('freeTextSearch', _params['free_text_search']))
 
+        if _params.get('add_lineage') is not None:  # noqa: E501
+            _query_params.append(('addLineage', _params['add_lineage']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters