Documentation for API Endpoints
All URIs are relative to https://fbn-prd.lusid.com/honeycomb
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApplicationMetadataApi | get_services_as_access_controlled_resources | GET /api/metadata/access/resources | GetServicesAsAccessControlledResources: Get resources available for access control |
| ApplicationMetadataApi | list_api_endpoints | GET /api/metadata/endpoints | ListApiEndpoints: Get the API endpoints available |
| BinaryDownloadingApi | download_binary | GET /api/Download/download | DownloadBinary: Download a Luminesce Binary you may run on-site |
| BinaryDownloadingApi | get_binary_versions | GET /api/Download/versions | GetBinaryVersions: List available versions of binaries |
| CertificateManagementApi | download_certificate | GET /api/Certificate/certificate | DownloadCertificate: Download domain or your personal certificates |
| CertificateManagementApi | list_certificates | GET /api/Certificate/certificates | ListCertificates: List previously minted certificates |
| CertificateManagementApi | manage_certificate | PUT /api/Certificate/manage | ManageCertificate: Create / Renew / Revoke a certificate |
| CurrentTableFieldCatalogApi | get_catalog | GET /api/Catalog | GetCatalog: Get a Flattened Table/Field Catalog |
| CurrentTableFieldCatalogApi | get_fields | GET /api/Catalog/fields | GetFields: List field and parameters for providers |
| CurrentTableFieldCatalogApi | get_providers | GET /api/Catalog/providers | GetProviders: List available providers |
| HealthCheckingEndpointApi | fake_node_reclaim | GET /fakeNodeReclaim | [INTERNAL] FakeNodeReclaim: Helps testing of AWS node reclaim behaviour |
| HistoricallyExecutedQueriesApi | cancel_history | DELETE /api/History/{executionId} | CancelHistory: Cancel / Clear data from a history search |
| HistoricallyExecutedQueriesApi | fetch_history_result_histogram | GET /api/History/{executionId}/histogram | FetchHistoryResultHistogram: Make a histogram of results of a history search |
| HistoricallyExecutedQueriesApi | fetch_history_result_json | GET /api/History/{executionId}/json | FetchHistoryResultJson: Fetch JSON results from a query history search |
| HistoricallyExecutedQueriesApi | get_history | GET /api/History | GetHistory: Start a background history search |
| HistoricallyExecutedQueriesApi | get_progress_of_history | GET /api/History/{executionId} | GetProgressOfHistory: View progress of a history search |
| MultiQueryExecutionApi | cancel_multi_query | DELETE /api/MultiQueryBackground/{executionId} | CancelMultiQuery: Cancel / Clear a previously started query-set |
| MultiQueryExecutionApi | download_multi_query_results | GET /api/MultiQueryBackground/{executionId}/download | DownloadMultiQueryResults: Downloads the results of a custom query-set as one file |
| MultiQueryExecutionApi | get_progress_of_multi_query | GET /api/MultiQueryBackground/{executionId} | GetProgressOfMultiQuery: View progress of the entire query-set load |
| MultiQueryExecutionApi | list_custom_queries | GET /api/MultiQueryBackground | ListCustomQueries: List the custom query-sets available to the calling user |
| MultiQueryExecutionApi | save_multi_query_results_to_drive | GET /api/MultiQueryBackground/{executionId}/drive | SaveMultiQueryResultsToDrive: Saves the results of a custom query-set directly to Drive, as one file |
| MultiQueryExecutionApi | start_custom_queries | PUT /api/MultiQueryBackground/custom | StartCustomQueries: Run a caller-supplied set of Sql queries in the background |
| MultiQueryExecutionApi | start_queries | PUT /api/MultiQueryBackground | StartQueries: Run a given set of Sql queries in the background |
| SqlBackgroundExecutionApi | cancel_query | DELETE /api/SqlBackground/{executionId} | CancelQuery: Cancel / Clear data from a previously run query |
| SqlBackgroundExecutionApi | fetch_query_result_csv | GET /api/SqlBackground/{executionId}/csv | FetchQueryResultCsv: Fetch the result of a query as CSV |
| SqlBackgroundExecutionApi | fetch_query_result_excel | GET /api/SqlBackground/{executionId}/excel | FetchQueryResultExcel: Fetch the result of a query as an Excel file |
| SqlBackgroundExecutionApi | fetch_query_result_histogram | GET /api/SqlBackground/{executionId}/histogram | FetchQueryResultHistogram: Construct a histogram of the result of a query |
| SqlBackgroundExecutionApi | 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 | GET /api/SqlBackground/{executionId}/jsonProper | FetchQueryResultJsonProper: Fetch the result of a query as JSON |
| SqlBackgroundExecutionApi | 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 | GET /api/SqlBackground/{executionId}/parquet | FetchQueryResultParquet: Fetch the result of a query as Parquet |
| SqlBackgroundExecutionApi | fetch_query_result_pipe | GET /api/SqlBackground/{executionId}/pipe | FetchQueryResultPipe: Fetch the result of a query as pipe-delimited |
| SqlBackgroundExecutionApi | fetch_query_result_sqlite | GET /api/SqlBackground/{executionId}/sqlite | FetchQueryResultSqlite: Fetch the result of a query as SqLite |
| SqlBackgroundExecutionApi | fetch_query_result_xml | GET /api/SqlBackground/{executionId}/xml | FetchQueryResultXml: Fetch the result of a query as XML |
| SqlBackgroundExecutionApi | get_historical_feedback | GET /api/SqlBackground/{executionId}/historicalFeedback | GetHistoricalFeedback: View historical query progress (for older queries) |
| SqlBackgroundExecutionApi | get_progress_of | GET /api/SqlBackground/{executionId} | GetProgressOf: View query progress up to this point. |
| SqlBackgroundExecutionApi | list_queries | GET /api/SqlBackground | ListQueries: List the background queries available to the calling user |
| SqlBackgroundExecutionApi | save_query_result_to_drive | GET /api/SqlBackground/{executionId}/drive | SaveQueryResultToDrive: Saves the query results directly to Drive |
| SqlBackgroundExecutionApi | start_query | PUT /api/SqlBackground | StartQuery: Start to Execute Sql in the background |
| SqlDesignApi | get_provider_template_for_export | GET /api/Sql/providertemplateforexport | GetProviderTemplateForExport: Makes a fields template for file importing via a writer |
| SqlDesignApi | put_case_statement_design_sql_to_design | PUT /api/Sql/tocasestatementdesign | PutCaseStatementDesignSqlToDesign: Convert SQL to a case statement design object |
| SqlDesignApi | put_case_statement_design_to_sql | PUT /api/Sql/fromcasestatementdesign | PutCaseStatementDesignToSql: Convert a case statement design object to SQL |
| SqlDesignApi | put_custom_queries_to_extract_scalar_parameters | PUT /api/Sql/extractscalarparameters/custom | PutCustomQueriesToExtractScalarParameters: Extract scalar parameter information from all the queries of a custom multi-query |
| SqlDesignApi | put_custom_queries_to_text | PUT /api/Sql/customqueries/totext | PutCustomQueriesToText: Convert the queries of a custom multi-query into its text |
| SqlDesignApi | put_file_read_design_to_sql | PUT /api/Sql/fromfilereaddesign | PutFileReadDesignToSql: Make file read SQL from a design object |
| SqlDesignApi | put_inlined_properties_design_sql_to_design | PUT /api/Sql/toinlinedpropertiesdesign | PutInlinedPropertiesDesignSqlToDesign: Make an inlined properties design from SQL |
| SqlDesignApi | put_inlined_properties_design_to_sql | PUT /api/Sql/frominlinedpropertiesdesign | PutInlinedPropertiesDesignToSql: Make inlined properties SQL from a design object |
| SqlDesignApi | put_intellisense | PUT /api/Sql/intellisense | PutIntellisense: Make intellisense prompts given an SQL snip-it |
| SqlDesignApi | put_intellisense_error | PUT /api/Sql/intellisenseError | PutIntellisenseError: Get error ranges from SQL |
| SqlDesignApi | put_lusid_grid_to_query | PUT /api/Sql/fromlusidgrid | [EXPERIMENTAL] PutLusidGridToQuery: Generates SQL from a dashboard view |
| SqlDesignApi | put_query_design_to_sql | PUT /api/Sql/fromdesign | PutQueryDesignToSql: Make SQL from a structured query design |
| SqlDesignApi | put_query_to_format | PUT /api/Sql/pretty | PutQueryToFormat: Format SQL into a more readable form |
| SqlDesignApi | put_sql_to_extract_scalar_parameters | PUT /api/Sql/extractscalarparameters | PutSqlToExtractScalarParameters: Extract scalar parameter information from SQL |
| SqlDesignApi | put_sql_to_file_read_design | PUT /api/Sql/tofilereaddesign | PutSqlToFileReadDesign: Make a design object from file-read SQL |
| SqlDesignApi | put_sql_to_query_design | PUT /api/Sql/todesign | PutSqlToQueryDesign: Make a SQL-design object from SQL if possible |
| SqlDesignApi | put_sql_to_view_design | PUT /api/Sql/toviewdesign | PutSqlToViewDesign: Make a view-design from view creation SQL |
| SqlDesignApi | put_sql_to_writer_design | PUT /api/Sql/towriterdesign | PutSqlToWriterDesign: Make a SQL-writer-design object from SQL |
| SqlDesignApi | put_text_to_custom_queries | PUT /api/Sql/customqueries/fromtext | PutTextToCustomQueries: Convert the text of a custom multi-query into its queries |
| SqlDesignApi | put_view_design_to_sql | PUT /api/Sql/fromviewdesign | PutViewDesignToSql: Make view creation sql from a view-design |
| SqlDesignApi | put_writer_design_to_sql | PUT /api/Sql/fromwriterdesign | PutWriterDesignToSql: Make writer SQL from a writer-design object |
| SqlExecutionApi | get_by_query_csv | GET /api/Sql/csv/{query} | GetByQueryCsv: Execute Sql from the url returning CSV |
| SqlExecutionApi | get_by_query_excel | GET /api/Sql/excel/{query} | GetByQueryExcel: Execute Sql from the url returning an Excel file |
| SqlExecutionApi | get_by_query_json | GET /api/Sql/json/{query} | GetByQueryJson: Execute Sql from the url returning JSON |
| SqlExecutionApi | get_by_query_parquet | GET /api/Sql/parquet/{query} | GetByQueryParquet: Execute Sql from the url returning a Parquet file |
| SqlExecutionApi | get_by_query_pipe | GET /api/Sql/pipe/{query} | GetByQueryPipe: Execute Sql from the url returning pipe-delimited |
| SqlExecutionApi | get_by_query_sqlite | GET /api/Sql/sqlite/{query} | GetByQuerySqlite: Execute Sql from the url returning SqLite DB |
| SqlExecutionApi | get_by_query_xml | GET /api/Sql/xml/{query} | GetByQueryXml: Execute Sql from the url returning XML |
| SqlExecutionApi | put_by_query_csv | PUT /api/Sql/csv | PutByQueryCsv: Execute Sql from the body returning CSV |
| SqlExecutionApi | put_by_query_excel | PUT /api/Sql/excel | PutByQueryExcel: Execute Sql from the body making an Excel file |
| SqlExecutionApi | put_by_query_json | PUT /api/Sql/json | PutByQueryJson: Execute Sql from the body returning JSON |
| SqlExecutionApi | put_by_query_parquet | PUT /api/Sql/parquet | PutByQueryParquet: Execute Sql from the body making a Parquet file |
| SqlExecutionApi | put_by_query_pipe | PUT /api/Sql/pipe | PutByQueryPipe: Execute Sql from the body making pipe-delimited |
| SqlExecutionApi | put_by_query_sqlite | PUT /api/Sql/sqlite | PutByQuerySqlite: Execute Sql from the body returning SqLite DB |
| SqlExecutionApi | put_by_query_xml | PUT /api/Sql/xml | PutByQueryXml: Execute Sql from the body returning XML |
| ViewManagementApi | delete_view | DELETE /api/View/update | [EXPERIMENTAL] DeleteView: Deletes a view by name |
| ViewManagementApi | get_view_creation_sql | PUT /api/View/sql | [EXPERIMENTAL] GetViewCreationSql: Gets the original source Sql for a view (if available) |
| ViewManagementApi | list_views | GET /api/View/list | [EXPERIMENTAL] ListViews: List views which are visible to the current user |
| ViewManagementApi | upsert_view | PUT /api/View/update | [EXPERIMENTAL] UpsertView: Creates or updates a view from a full ViewDefinition. |
Documentation for Models
- AccessControlledAction
- AccessControlledResource
- AccessControlledResourceIdentifierPartSchemaAttribute
- ActionId
- AggregateFunction
- Aggregation
- ApiEndpoint
- AutoDetectType
- AvailableField
- AvailableParameter
- BackgroundMultiQueryProgressResponse
- BackgroundMultiQueryResponse
- BackgroundQueryCancelResponse
- BackgroundQueryListItem
- BackgroundQueryProgressResponse
- BackgroundQueryResponse
- BackgroundQueryState
- CaseStatementDesign
- CaseStatementItem
- CertificateAction
- CertificateFileType
- CertificateState
- CertificateStatus
- CertificateType
- Column
- ColumnInfo
- ColumnStateType
- ConditionAttributes
- ConvertToViewData
- CursorPosition
- CustomMultiQueryExport
- CustomMultiQueryItem
- CustomMultiQueryListItem
- CustomMultiQueryListItemQuery
- CustomMultiQueryRequest
- DashboardType
- DataType
- DateParameters
- DesignJoinType
- ErrorHighlightItem
- ErrorHighlightRequest
- ErrorHighlightResponse
- ExportType
- ExpressionWithAlias
- ExternalQuerySource
- FeedbackEventArgs
- FeedbackLevel
- FieldDesign
- FieldType
- FileReaderBuilderDef
- FileReaderBuilderResponse
- FilterModel
- FilterTermDesign
- FilterType
- IdSelectorDefinition
- InlinedPropertyDesign
- InlinedPropertyItem
- IntellisenseItem
- IntellisenseRequest
- IntellisenseResponse
- IntellisenseType
- JoinedTableDesign
- Lineage
- LineageColumnIcon
- Link
- LuminesceBinaryType
- LusidGridData
- LusidProblemDetails
- MappableField
- MappingFlags
- MultiQueryDefinitionType
- MultiQueryExportState
- OnClauseTermDesign
- OptionsCsv
- OptionsExcel
- OptionsParquet
- OptionsSqLite
- OptionsXml
- OrderByDirection
- OrderByTermDesign
- QueryDesign
- QueryDesignerBinaryOperator
- QueryDesignerVersion
- ResourceId
- ResourceListOfAccessControlledResource
- ScalarParameter
- ServiceApiEndpoints
- Source
- SourceType
- SqlExecutionFlags
- TableLineage
- TableMeta
- TableView
- TaskStatus
- Type
- ViewItem
- ViewParameter
- WriterDesign
1 maintainer
Metadata
1 maintainer
Release files for luminesce-sdk 2.4.188
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| luminesce_sdk-2.4.188.tar.gz | 136.4 kB | Without provenance | Details for luminesce_sdk-2.4.188.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| luminesce_sdk-2.4.188-py3-none-any.whl | Python 3 | none | any | Details for luminesce_sdk-2.4.188-py3-none-any.whl |
Total release size: 395.7 kB
Release files / luminesce_sdk-2.4.188.tar.gz
| Download URL | luminesce_sdk-2.4.188.tar.gz |
|---|---|
| Size | 136.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b581d3a33fefeb37a69ba7dac346f426010578af18bc7aaafa442367f0dcd000
|
|
BLAKE2b-256 checksum How to use checksums |
3e0e27edd3c12226ebbeafeaef03885139a80c2372ca7d614b1937b477b55e89
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.11.9 Linux/6.12.54-flatcar
|
Release files / luminesce_sdk-2.4.188-py3-none-any.whl
| Download URL | luminesce_sdk-2.4.188-py3-none-any.whl |
|---|---|
| Size | 259.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
06e6de1804b8da584ee1bafa52039a38c9aeae971d2f502c0687166c39eef69d
|
|
BLAKE2b-256 checksum How to use checksums |
659c01ff5d2d36c8c88b18eb43e268d23e4cad113fc53954a716b367355e7bc2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.11.9 Linux/6.12.54-flatcar
|
Security for luminesce-sdk 2.4.188
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
