Skip to main content

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 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:

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:

import gooddata_scan_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gooddata_scan_client

Getting Started

Please follow the installation procedure and then run the following:

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 GET /api/v1/actions/dataSources/{dataSourceId}/scanSchemata Get a list of schema names of a database
ScanningApi scan_data_source POST /api/v1/actions/dataSources/{dataSourceId}/scan Scan a database to get a physical data model (PDM)
TestConnectionApi test_data_source POST /api/v1/actions/dataSources/{dataSourceId}/test Test data source connection by data source id
TestConnectionApi test_data_source_definition POST /api/v1/actions/dataSource/test Test connection by data source definition
ActionsApi get_data_source_schemata GET /api/v1/actions/dataSources/{dataSourceId}/scanSchemata Get a list of schema names of a database
ActionsApi scan_data_source POST /api/v1/actions/dataSources/{dataSourceId}/scan Scan a database to get a physical data model (PDM)
ActionsApi scan_sql POST /api/v1/actions/dataSources/{dataSourceId}/scanSql Collect metadata about SQL query
ActionsApi test_data_source POST /api/v1/actions/dataSources/{dataSourceId}/test Test data source connection by data source id
ActionsApi test_data_source_definition POST /api/v1/actions/dataSource/test Test connection by data source definition

Documentation For Models

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 *

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gooddata-scan-client-1.3.0.tar.gz (53.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gooddata_scan_client-1.3.0-py3-none-any.whl (95.9 kB view details)

Uploaded Python 3

File details

Details for the file gooddata-scan-client-1.3.0.tar.gz.

File metadata

  • Download URL: gooddata-scan-client-1.3.0.tar.gz
  • Upload date:
  • Size: 53.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for gooddata-scan-client-1.3.0.tar.gz
Algorithm Hash digest
SHA256 d707329b82fc77841323ce65981acd694a4962ecea9cd9ea07e486dd0301b170
MD5 61a5bc9338473f2c927477d1f3df5e6e
BLAKE2b-256 b95f79948d22f85e0fdea30e807efd36abf762628512be57fa3318ff4dd82f98

See more details on using hashes here.

File details

Details for the file gooddata_scan_client-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gooddata_scan_client-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8db0aaac335f8eeccbf53a7d650751a0faf497927d1864d1b8b2a260ea2b125
MD5 ab9f6de71d0813c9c20588faec786722
BLAKE2b-256 b306b86c60c8ac81df03bcb66d4c161445dbb33fa0080bf033f7b5ea864b6b2b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.8.0

2 files

0.7.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page