Skip to main content

Get Imports

Obtain the ClickHouse formats to import and export your data.

Obtain your Imports

curl -X 'GET' \
'https://api.gigapipe.com/v1/clusters/<your_cluster_slug>/imports' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <your_access_token>'
# Payload response while importing ::Array[Dictionary]
[
{
"table": "Your table name",
"source": "AWS S3",
"path": "your_s3_path",
"format": {
"name": "CSVWithNames",
"imports": True,
"exports": True
},
"status": "In progress",
"rows": None,
"bytes": None,
"duration_ms": None,
"error": None,
"created_at": "2022-02-16T11:28:21.559138"
}
...
]
# Payload response when the import has finished ::Array[Dictionary]
[
{
"table": "Your table name",
"source": "AWS S3",
"path": "your_s3_path",
"format": {
"name": "CSVWithNames",
"imports": True,
"exports": True
},
"status": "Succeeded",
"rows": 122488236,
"bytes": 7104317688,
"duration_ms": 236832,
"error": "",
"created_at": "2022-02-16T11:28:21.559138"
}
...
]

Parameters

Attributes


cluster_slug  ::Optional[String]

The cluster slug


Response

Attributes


table  ::String

The table name


source  ::String

The source you imported the data from


path  ::String

Your source path


format  ::String

The format you used to import the data

name  ::String

The name of the import you used to import the data

imports  ::Boolean

Whether the type allows to import data

exports  ::Boolean

Whether the type allows to export data

status  ::String

The status of the import at the moment

rows  ::Optional[Integer]

The number of rows that have been inserted

bytes  ::Optional[Integer]

The number of bytes that have been inserted

duration_ms  ::Optional[Integer]

How long it took for ClickHouse to get the data inserted

error  ::Optional[String]

Whether an error has occurred when importing the data

created_at  ::String

moment when it started importing data