cloudflare
Version:
The official TypeScript library for the Cloudflare API
149 lines • 5.4 kB
text/typescript
import { APIResource } from "../../../../core/resource.mjs";
import * as MaintenanceConfigsAPI from "./maintenance-configs.mjs";
import { BaseMaintenanceConfigs, MaintenanceConfigGetParams, MaintenanceConfigGetResponse, MaintenanceConfigUpdateParams, MaintenanceConfigUpdateResponse, MaintenanceConfigs } from "./maintenance-configs.mjs";
import { APIPromise } from "../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../internal/request-options.mjs";
export declare class BaseTables extends APIResource {
static readonly _key: readonly ['basinCatalog', 'namespaces', 'tables'];
/**
* Returns a list of tables in the specified namespace within a Basin Catalog.
* Supports pagination for efficient traversal of large table collections.
*
* @example
* ```ts
* const tables =
* await client.basinCatalog.namespaces.tables.list(
* 'bronze',
* {
* account_id: '0123456789abcdef0123456789abcdef',
* bucket_name: 'my-data-bucket',
* },
* );
* ```
*/
list(namespace: string, params: TableListParams, options?: RequestOptions): APIPromise<TableListResponse>;
}
export declare class Tables extends BaseTables {
maintenanceConfigs: MaintenanceConfigsAPI.MaintenanceConfigs;
}
/**
* Contains the list of tables with optional pagination.
*/
export interface TableListResponse {
/**
* Lists tables in the namespace.
*/
identifiers: Array<TableListResponse.Identifier>;
/**
* Contains detailed metadata for each table when return_details is true. Each
* object includes identifier, UUID, timestamps, and locations.
*/
details?: Array<TableListResponse.Detail> | null;
/**
* Use this opaque token to fetch the next page of results. A null or absent value
* indicates the last page.
*/
next_page_token?: string | null;
/**
* Contains UUIDs for each table when return_uuids is true. The order corresponds
* to the identifiers array.
*/
table_uuids?: Array<string> | null;
}
export declare namespace TableListResponse {
/**
* Specifies a unique table identifier within a catalog.
*/
interface Identifier {
/**
* Specifies the table name.
*/
name: string;
/**
* Specifies the hierarchical namespace parts as an array of strings. For example,
* ["bronze", "analytics"] represents the namespace "bronze.analytics".
*/
namespace: Array<string>;
}
/**
* Contains table with metadata.
*/
interface Detail {
/**
* Specifies a unique table identifier within a catalog.
*/
identifier: Detail.Identifier;
/**
* Contains the UUID that persists across renames.
*/
table_uuid: string;
/**
* Indicates the creation timestamp in ISO 8601 format.
*/
created_at?: string | null;
/**
* Specifies the base S3 URI for table storage location.
*/
location?: string | null;
/**
* Contains the S3 URI to table metadata file. Null for staged tables.
*/
metadata_location?: string | null;
/**
* Shows the last update timestamp in ISO 8601 format. Null if never updated.
*/
updated_at?: string | null;
}
namespace Detail {
/**
* Specifies a unique table identifier within a catalog.
*/
interface Identifier {
/**
* Specifies the table name.
*/
name: string;
/**
* Specifies the hierarchical namespace parts as an array of strings. For example,
* ["bronze", "analytics"] represents the namespace "bronze.analytics".
*/
namespace: Array<string>;
}
}
}
export interface TableListParams {
/**
* Path param: Identifies the account.
*/
account_id: string;
/**
* Path param: Specifies the R2 bucket name.
*/
bucket_name: string;
/**
* Query param: Maximum number of tables to return per page. Defaults to 100,
* maximum 1000.
*/
page_size?: number;
/**
* Query param: Opaque pagination token from a previous response. Use this to fetch
* the next page of results.
*/
page_token?: string;
/**
* Query param: Whether to include additional metadata (timestamps, locations).
* When true, response includes created_at, updated_at, metadata_locations, and
* locations arrays.
*/
return_details?: boolean;
/**
* Query param: Whether to include table UUIDs in the response. Set to true to
* receive the table_uuids array.
*/
return_uuids?: boolean;
}
export declare namespace Tables {
export { type TableListResponse as TableListResponse, type TableListParams as TableListParams };
export { MaintenanceConfigs as MaintenanceConfigs, BaseMaintenanceConfigs as BaseMaintenanceConfigs, type MaintenanceConfigUpdateResponse as MaintenanceConfigUpdateResponse, type MaintenanceConfigGetResponse as MaintenanceConfigGetResponse, type MaintenanceConfigUpdateParams as MaintenanceConfigUpdateParams, type MaintenanceConfigGetParams as MaintenanceConfigGetParams, };
}
//# sourceMappingURL=tables.d.mts.map