Lakehouse API
The Lakehouse API (formerly BigLake API) provides access to a serverless, fully managed, and highly available metastore that provides a single source of truth…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Lakehouse API (formerly BigLake API) provides access to a serverless, fully managed, and highly available metastore that provides a single source of truth for your data lakehouse. It lets multiple engines—including Apache Spark, Google Managed Spark, Apache Flink, Trino and BigQuery—share tables and metadata for key open formats (Apache Iceberg, Apache Hive), and query the same copy of data. Plus, through the Lakehouse runtime catalog federation seamlessly unite your lakehouse ecosystem, letting Iceberg compatible engines on Google Cloud (BigQuery, Google Managed Spark) discover and analyze enterprise data across Snowflake, Databricks, and AWS Glue.
Endpoints 13
projects.catalogs.namespaces.views
- GETGets the IAM policy for the specified View.
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the IAM policy for the specified View. - POSTSets the IAM policy for the specified view.
/v1/:resource:setIamPolicySets the IAM policy for the specified view. - POSTTests the IAM permissions for the specified view.
/v1/:resource:testIamPermissionsTests the IAM permissions for the specified view.
projects.locations.catalogs
- GETList all catalogs in a specified project.
/v1/:parent/catalogs?pageSize=0&pageToken=stringList all catalogs in a specified project. - POSTCreates a new catalog.
/v1/:parent/catalogs?catalogId=stringCreates a new catalog.
projects.locations.catalogs.databases.tables
- GETGets the table specified by the resource name.
/v1/:nameGets the table specified by the resource name. - DELETEDeletes an existing table specified by the table ID.
/v1/:nameDeletes an existing table specified by the table ID. - PATCHUpdates an existing table specified by the table ID.
/v1/:name?updateMask=stringUpdates an existing table specified by the table ID. - GETList all tables in a specified database.
/v1/:parent/tables?pageSize=0&pageToken=string&view=TABLE_VIEW_UNSPECIFIEDList all tables in a specified database. - POSTCreates a new table.
/v1/:parent/tables?tableId=stringCreates a new table. - POSTRenames an existing table specified by the table ID.
/v1/:name:renameRenames an existing table specified by the table ID.
projects.locations.catalogs.databases
- GETList all databases in a specified catalog.
/v1/:parent/databases?pageSize=0&pageToken=stringList all databases in a specified catalog. - POSTCreates a new database.
/v1/:parent/databases?databaseId=stringCreates a new database.
API details
- Base URL
https://biglake.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 13 operations on 8 pathsPOST 6GET 5PATCH 1DELETE 1
- Main resources
- projects.locations.catalogs.databases.tables 6projects.catalogs.namespaces.views 3projects.locations.catalogs 2projects.locations.catalogs.databases 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Lakehouse API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Lakehouse API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the IAM policy for the specified View.” (GET /v1/:resource:getIamPolicy?options.requestedPolicyVersion=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Lakehouse API?
The Lakehouse API (formerly BigLake API) provides access to a serverless, fully managed, and highly available metastore that provides a single source of truth… It is listed under Data & analytics and has 13 endpoints.
Who publishes the Lakehouse API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Lakehouse API?
Requests go to https://biglake.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Lakehouse API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Lakehouse API have?
13 operations on 8 paths (6 POST, 5 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.catalogs.databases.tables, projects.catalogs.namespaces.views, projects.locations.catalogs, projects.locations.catalogs.databases.
Is forking the Lakehouse API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.