Skip to content

Latest commit

 

History

History
368 lines (261 loc) · 12.2 KB

TableImport.md

File metadata and controls

368 lines (261 loc) · 12.2 KB

TableImport

Method HTTP request Release Stage
create POST /v2/connectivity/connections/{connectionRid}/tableImports Stable
delete DELETE /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} Stable
execute POST /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute Stable
get GET /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} Stable
list GET /v2/connectivity/connections/{connectionRid}/tableImports Stable
replace PUT /v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid} Stable

create

Creates a new TableImport.

Parameters

Name Type Description Notes
connection_rid ConnectionRid
config CreateTableImportRequestTableImportConfig
dataset_rid DatasetRid The RID of the output dataset. Can not be modified after the table import is created.
display_name TableImportDisplayName
import_mode TableImportMode
allow_schema_changes Optional[TableImportAllowSchemaChanges] Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports. [optional]
branch_name Optional[BranchName] The branch name in the output dataset that will contain the imported data. Defaults to master for most enrollments. Can not be modified after the table import is created. [optional]

Return type

TableImport

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# CreateTableImportRequestTableImportConfig
config = {"type": "jdbcImportConfig", "query": "SELECT * FROM table"}
# DatasetRid | The RID of the output dataset. Can not be modified after the table import is created.
dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
# TableImportDisplayName
display_name = "My table import"
# TableImportMode
import_mode = "SNAPSHOT"
# Optional[TableImportAllowSchemaChanges] | Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports.
allow_schema_changes = True
# Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. Can not be modified after the table import is created.
branch_name = "master"


try:
    api_response = client.connectivity.Connection.TableImport.create(
        connection_rid,
        config=config,
        dataset_rid=dataset_rid,
        display_name=display_name,
        import_mode=import_mode,
        allow_schema_changes=allow_schema_changes,
        branch_name=branch_name,
    )
    print("The create response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TableImport.create: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 TableImport The created TableImport application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

Delete the TableImport with the specified RID. Deleting the table import does not delete the destination dataset but the dataset will no longer be updated by this import.

Parameters

Name Type Description Notes
connection_rid ConnectionRid
table_import_rid TableImportRid

Return type

None

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# TableImportRid
table_import_rid = None


try:
    api_response = client.connectivity.Connection.TableImport.delete(
        connection_rid, table_import_rid
    )
    print("The delete response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TableImport.delete: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
204 None None

[Back to top] [Back to API list] [Back to Model list] [Back to README]

execute

Executes the TableImport, which runs asynchronously as a Foundry Build. The returned BuildRid can be used to check the status via the Orchestration API.

Parameters

Name Type Description Notes
connection_rid ConnectionRid
table_import_rid TableImportRid

Return type

BuildRid

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# TableImportRid
table_import_rid = None


try:
    api_response = client.connectivity.Connection.TableImport.execute(
        connection_rid, table_import_rid
    )
    print("The execute response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TableImport.execute: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 BuildRid application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Get the TableImport with the specified rid.

Parameters

Name Type Description Notes
connection_rid ConnectionRid
table_import_rid TableImportRid

Return type

TableImport

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# TableImportRid
table_import_rid = None


try:
    api_response = client.connectivity.Connection.TableImport.get(connection_rid, table_import_rid)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TableImport.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 TableImport application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

Lists all table imports defined for this connection. Only table imports that the user has permissions to view will be returned.

Parameters

Name Type Description Notes
connection_rid ConnectionRid
page_size Optional[PageSize] The page size to use for the endpoint. [optional]
page_token Optional[PageToken] The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request. [optional]

Return type

ListTableImportsResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# Optional[PageSize] | The page size to use for the endpoint.
page_size = None
# Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.
page_token = None


try:
    for table_import in client.connectivity.Connection.TableImport.list(
        connection_rid, page_size=page_size, page_token=page_token
    ):
        pprint(table_import)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TableImport.list: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ListTableImportsResponse application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace

Replace the TableImport with the specified rid.

Parameters

Name Type Description Notes
connection_rid ConnectionRid
table_import_rid TableImportRid
config ReplaceTableImportRequestTableImportConfig
display_name TableImportDisplayName
import_mode TableImportMode
allow_schema_changes Optional[TableImportAllowSchemaChanges] Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports. [optional]

Return type

TableImport

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# ConnectionRid
connection_rid = None
# TableImportRid
table_import_rid = None
# ReplaceTableImportRequestTableImportConfig
config = {"type": "jdbcImportConfig", "query": "SELECT * FROM table"}
# TableImportDisplayName
display_name = "My table import"
# TableImportMode
import_mode = "SNAPSHOT"
# Optional[TableImportAllowSchemaChanges] | Allow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports.
allow_schema_changes = True


try:
    api_response = client.connectivity.Connection.TableImport.replace(
        connection_rid,
        table_import_rid,
        config=config,
        display_name=display_name,
        import_mode=import_mode,
        allow_schema_changes=allow_schema_changes,
    )
    print("The replace response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TableImport.replace: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 TableImport The replaced TableImport application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]