API reference (20230101-alpha)
custom_table_list = client.postgres_gateway.tables.list("myUserName", limit=5)
for table in client.postgres_gateway.tables:
table # do something with the custom table
for table_list in client.postgres_gateway.tables(chunk_size=25):
table_list # do something with the custom tables{
"items": [
{
"columns": {},
"type": "raw_rows",
"tablename": "<string>",
"options": {
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
}
],
"nextCursor": "<string>"
}Required capabilities:
postgresGateway:READ
List all tables in a given project. If more than limit tables exist, a cursor for pagination will be returned with the response.
custom_table_list = client.postgres_gateway.tables.list("myUserName", limit=5)
for table in client.postgres_gateway.tables:
table # do something with the custom table
for table_list in client.postgres_gateway.tables(chunk_size=25):
table_list # do something with the custom tables{
"items": [
{
"columns": {},
"type": "raw_rows",
"tablename": "<string>",
"options": {
"space": "<string>",
"externalId": "<string>",
"version": "<string>"
}
}
],
"nextCursor": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
The name of the username (a.k.a. database) to be managed from the API Username to authenticate the user on the DB.
Query Parameters
Limits the number of results to be returned. The maximum results returned by the server is 100 even if you specify a higher limit.
1 <= x <= 100Cursor for paging through results. In general, if a response contains a nextCursor
property, it means that there may be more results, and you should pass that value as the
cursor parameter in the next request.
Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.
"4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo"
Determines if API should return built-in tables or not
Was this page helpful?