Skip to content

README.md

Latest commit

 

History

History
647 lines (434 loc) · 49.3 KB

README.md

File metadata and controls

647 lines (434 loc) · 49.3 KB
Raw

Datasets

Overview

Available Operations

create_folder

CreateFolder

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.create_folder()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
parent_path List[str] ➖ parent folders must already exist
name Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceCreateFolderResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

create_power_bi_dataset

CreatePowerBIDataset

Example Usage

import os
from textql_sdk import Textql
from textql_sdk.utils import parse_datetime


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.create_power_bi_dataset(reports=[
        {
            "created_date": parse_datetime("2023-01-15T01:30:15.01Z"),
        },
    ], datasets=[
        {
            "created_date": parse_datetime("2023-01-15T01:30:15.01Z"),
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
connector_id Optional[int] ➖ N/A
name Optional[str] ➖ N/A
folder_path List[str] ➖ N/A
workspace_id Optional[str] ➖ N/A
workspace_name Optional[str] ➖ N/A
reports List[models.TextqlRPCPublicPowerbiPowerBIReport] ➖ N/A
datasets List[models.TextqlRPCPublicPowerbiPowerBIDataset] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceCreatePowerBIDatasetResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

create_tableau_dataset

Create Tableau dataset from views/datasources

Example Usage

import os
from textql_sdk import Textql
from textql_sdk.utils import parse_datetime


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.create_tableau_dataset(views=[
        {
            "created_at": parse_datetime("2023-01-15T01:30:15.01Z"),
            "updated_at": parse_datetime("2023-01-15T01:30:15.01Z"),
        },
    ], datasources=[
        {
            "created_at": parse_datetime("2023-01-15T01:30:15.01Z"),
            "updated_at": parse_datetime("2023-01-15T01:30:15.01Z"),
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
connector_id Optional[int] ➖ N/A
name Optional[str] ➖ N/A
folder_path List[str] ➖ N/A
project_id Optional[str] ➖ N/A
project_name Optional[str] ➖ N/A
views List[models.TextqlRPCPublicTableauTableauView] ➖ N/A
datasources List[models.TextqlRPCPublicTableauTableauDatasource] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceCreateTableauDatasetResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

create_upload_presign_url

uploads

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.create_upload_presign_url()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
type Optional[models.TextqlRPCPublicDatasetDatasetType] ➖ never change the names or numbers of existing dataset types!
file_name Optional[str] ➖ N/A
folder_path List[str] ➖ if this dataset lives in a folder
ephemeral Optional[bool] ➖ N/A
expires_in_days OptionalNullable[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceCreateUploadPresignURLResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

delete

Delete a dataset (soft delete)

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.delete()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceDeleteDatasetResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

export

export dataset in "raw" format – original if dataset is uploaded, converted format otherwise (defaults to CSV)

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.export()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
preferred_format Optional[models.TextqlRPCPublicDatasetExportFormat] ➖ N/A
version_id OptionalNullable[int] ➖ default to latest version
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceExportDatasetResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

fetch

GetDataset, GetDatasets only return metadata

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.fetch()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceGetDatasetResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

get_stats

GetDatasetStats

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.get_stats()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
version_id OptionalNullable[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceGetDatasetStatsResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

get_dataset_values

GetDatasetValues

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.get_dataset_values()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
version_id OptionalNullable[int] ➖ default to latest version
limit OptionalNullable[int] ➖ defaults to 10,000
page OptionalNullable[int] ➖ N/A
sheet OptionalNullable[int] ➖ for multi-sheet excels
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceGetDatasetValuesResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

get

GetDatasets

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.get()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
types List[models.TextqlRPCPublicDatasetDatasetType] ➖ N/A
owner_only Optional[bool] ➖ only include datasets where the user is the owner
include_subfolders Optional[bool] ➖ N/A
path OptionalNullable[str] ➖ defaults to path /
search_param OptionalNullable[str] ➖ N/A
sort Optional[models.TextqlRPCPublicDatasetDatasetsSort] ➖ N/A
limit OptionalNullable[int] ➖ N/A
cursor OptionalNullable[str] ➖ cursor-based pagination. cursor is the id of the last record returned
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceGetDatasetsResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

get_by_ids

GetDatasetsByIds

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.get_by_ids()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_ids List[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceGetDatasetsByIdsResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

get_folders

for AR: CreateFolderACL, UpdateFolderACL, DeleteFolderACL

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.get_folders()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
path Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceGetFoldersResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

process_upload_presign_url

for AR: CreateDatasetACL, UpdateDatasetACL, DeleteDatasetACL

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.process_upload_presign_url()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
dataset_version Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceProcessUploadPresignURLResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*

update_dataset

Update dataset metadata

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.datasets.update_dataset()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
connect_timeout_ms Optional[float] ➖ N/A
dataset_id Optional[str] ➖ N/A
name OptionalNullable[str] ➖ Add other updatable fields as needed
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DatasetServiceUpdateDatasetResponse

Errors

Error Type Status Code Content Type
errors.TextqlDefaultError 4XX, 5XX */*