# gooddata-scan-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v0
- Package version: 1.3.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python >=3.6
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import gooddata_scan_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import gooddata_scan_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import gooddata_scan_client
from pprint import pprint
from gooddata_scan_client.api import scanning_api
from gooddata_scan_client.model.data_source_schemata import DataSourceSchemata
from gooddata_scan_client.model.scan_request import ScanRequest
from gooddata_scan_client.model.scan_result_pdm import ScanResultPdm
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_scan_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with gooddata_scan_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = scanning_api.ScanningApi(api_client)
data_source_id = "myPostgres" # str | Data source id
try:
# Get a list of schema names of a database
api_response = api_instance.get_data_source_schemata(data_source_id)
pprint(api_response)
except gooddata_scan_client.ApiException as e:
print("Exception when calling ScanningApi->get_data_source_schemata: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ScanningApi* | [**get_data_source_schemata**](docs/ScanningApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database
*ScanningApi* | [**scan_data_source**](docs/ScanningApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM)
*TestConnectionApi* | [**test_data_source**](docs/TestConnectionApi.md#test_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/test | Test data source connection by data source id
*TestConnectionApi* | [**test_data_source_definition**](docs/TestConnectionApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
*ActionsApi* | [**get_data_source_schemata**](docs/ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database
*ActionsApi* | [**scan_data_source**](docs/ActionsApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM)
*ActionsApi* | [**scan_sql**](docs/ActionsApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query
*ActionsApi* | [**test_data_source**](docs/ActionsApi.md#test_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/test | Test data source connection by data source id
*ActionsApi* | [**test_data_source_definition**](docs/ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition
## Documentation For Models
- [ColumnWarning](docs/ColumnWarning.md)
- [DataSourceParameter](docs/DataSourceParameter.md)
- [DataSourceSchemata](docs/DataSourceSchemata.md)
- [DeclarativeColumn](docs/DeclarativeColumn.md)
- [DeclarativeTable](docs/DeclarativeTable.md)
- [DeclarativeTables](docs/DeclarativeTables.md)
- [ScanRequest](docs/ScanRequest.md)
- [ScanResultPdm](docs/ScanResultPdm.md)
- [ScanSqlRequest](docs/ScanSqlRequest.md)
- [ScanSqlResponse](docs/ScanSqlResponse.md)
- [SqlColumn](docs/SqlColumn.md)
- [TableWarning](docs/TableWarning.md)
- [TestDefinitionRequest](docs/TestDefinitionRequest.md)
- [TestQueryDuration](docs/TestQueryDuration.md)
- [TestRequest](docs/TestRequest.md)
- [TestResponse](docs/TestResponse.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
support@gooddata.com
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in gooddata_scan_client.apis and gooddata_scan_client.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1:
Use specific imports for apis and models like:
- `from gooddata_scan_client.api.default_api import DefaultApi`
- `from gooddata_scan_client.model.pet import Pet`
Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import gooddata_scan_client
from gooddata_scan_client.apis import *
from gooddata_scan_client.models import *
```
Raw data
{
"_id": null,
"home_page": "",
"name": "gooddata-scan-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,OpenAPI definition",
"author": "GoodData (generated by OpenAPI Generator)",
"author_email": "support@gooddata.com",
"download_url": "https://files.pythonhosted.org/packages/b9/5f/79948d22f85e0fdea30e807efd36abf762628512be57fa3318ff4dd82f98/gooddata-scan-client-1.3.0.tar.gz",
"platform": null,
"description": "# gooddata-scan-client\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v0\n- Package version: 1.3.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >=3.6\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport gooddata_scan_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport gooddata_scan_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport gooddata_scan_client\nfrom pprint import pprint\nfrom gooddata_scan_client.api import scanning_api\nfrom gooddata_scan_client.model.data_source_schemata import DataSourceSchemata\nfrom gooddata_scan_client.model.scan_request import ScanRequest\nfrom gooddata_scan_client.model.scan_result_pdm import ScanResultPdm\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = gooddata_scan_client.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith gooddata_scan_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = scanning_api.ScanningApi(api_client)\n data_source_id = \"myPostgres\" # str | Data source id\n\n try:\n # Get a list of schema names of a database\n api_response = api_instance.get_data_source_schemata(data_source_id)\n pprint(api_response)\n except gooddata_scan_client.ApiException as e:\n print(\"Exception when calling ScanningApi->get_data_source_schemata: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ScanningApi* | [**get_data_source_schemata**](docs/ScanningApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database\n*ScanningApi* | [**scan_data_source**](docs/ScanningApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM)\n*TestConnectionApi* | [**test_data_source**](docs/TestConnectionApi.md#test_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/test | Test data source connection by data source id\n*TestConnectionApi* | [**test_data_source_definition**](docs/TestConnectionApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition\n*ActionsApi* | [**get_data_source_schemata**](docs/ActionsApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database\n*ActionsApi* | [**scan_data_source**](docs/ActionsApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM)\n*ActionsApi* | [**scan_sql**](docs/ActionsApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query\n*ActionsApi* | [**test_data_source**](docs/ActionsApi.md#test_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/test | Test data source connection by data source id\n*ActionsApi* | [**test_data_source_definition**](docs/ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition\n\n\n## Documentation For Models\n\n - [ColumnWarning](docs/ColumnWarning.md)\n - [DataSourceParameter](docs/DataSourceParameter.md)\n - [DataSourceSchemata](docs/DataSourceSchemata.md)\n - [DeclarativeColumn](docs/DeclarativeColumn.md)\n - [DeclarativeTable](docs/DeclarativeTable.md)\n - [DeclarativeTables](docs/DeclarativeTables.md)\n - [ScanRequest](docs/ScanRequest.md)\n - [ScanResultPdm](docs/ScanResultPdm.md)\n - [ScanSqlRequest](docs/ScanSqlRequest.md)\n - [ScanSqlResponse](docs/ScanSqlResponse.md)\n - [SqlColumn](docs/SqlColumn.md)\n - [TableWarning](docs/TableWarning.md)\n - [TestDefinitionRequest](docs/TestDefinitionRequest.md)\n - [TestQueryDuration](docs/TestQueryDuration.md)\n - [TestRequest](docs/TestRequest.md)\n - [TestResponse](docs/TestResponse.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\nsupport@gooddata.com\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in gooddata_scan_client.apis and gooddata_scan_client.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from gooddata_scan_client.api.default_api import DefaultApi`\n- `from gooddata_scan_client.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport gooddata_scan_client\nfrom gooddata_scan_client.apis import *\nfrom gooddata_scan_client.models import *\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "OpenAPI definition",
"version": "1.3.0",
"split_keywords": [
"openapi",
"openapi-generator",
"openapi definition"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b306b86c60c8ac81df03bcb66d4c161445dbb33fa0080bf033f7b5ea864b6b2b",
"md5": "ab9f6de71d0813c9c20588faec786722",
"sha256": "c8db0aaac335f8eeccbf53a7d650751a0faf497927d1864d1b8b2a260ea2b125"
},
"downloads": -1,
"filename": "gooddata_scan_client-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab9f6de71d0813c9c20588faec786722",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 95857,
"upload_time": "2023-03-10T09:54:32",
"upload_time_iso_8601": "2023-03-10T09:54:32.519098Z",
"url": "https://files.pythonhosted.org/packages/b3/06/b86c60c8ac81df03bcb66d4c161445dbb33fa0080bf033f7b5ea864b6b2b/gooddata_scan_client-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b95f79948d22f85e0fdea30e807efd36abf762628512be57fa3318ff4dd82f98",
"md5": "61a5bc9338473f2c927477d1f3df5e6e",
"sha256": "d707329b82fc77841323ce65981acd694a4962ecea9cd9ea07e486dd0301b170"
},
"downloads": -1,
"filename": "gooddata-scan-client-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "61a5bc9338473f2c927477d1f3df5e6e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 53328,
"upload_time": "2023-03-10T09:54:39",
"upload_time_iso_8601": "2023-03-10T09:54:39.551102Z",
"url": "https://files.pythonhosted.org/packages/b9/5f/79948d22f85e0fdea30e807efd36abf762628512be57fa3318ff4dd82f98/gooddata-scan-client-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-10 09:54:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "gooddata-scan-client"
}
JSON