Skip to main content

Lakes

Register and manage data lakes — either Onehouse-managed or observed (external).

Methods

MethodDescription
create_lakeRegister a new lake
alter_lakeChange a lake's default services cluster
delete_lakeDelete a lake
show_lakesList all lakes in the project

create_lake

create_lake(
name: str,
*,
lake_type: str,
bucket_path: str,
default_services_cluster: str,
unsafe_raw: bool = False,
timeout: float | None = None,
poll_interval: float | None = None,
)
ParameterRequiredType / values
nameyesstr
lake_typeyes"MANAGED", "OBSERVED"
bucket_pathyesstr — e.g. s3://my-bucket/lake
default_services_clusteryesstr — cluster name that runs table services for this lake

Example

client.create_lake(
"analytics",
lake_type="MANAGED",
bucket_path="s3://my-bucket/lake",
default_services_cluster="services",
)

alter_lake

alter_lake(
name: str,
*,
default_services_cluster: str,
unsafe_raw: bool = False,
timeout: float | None = None,
poll_interval: float | None = None,
)

Example

client.alter_lake("analytics", default_services_cluster="services-v2")

delete_lake

delete_lake(
name: str,
*,
cascade: bool = False,
unsafe_raw: bool = False,
timeout: float | None = None,
poll_interval: float | None = None,
)
ParameterRequiredType / values
nameyesstr
cascadenobool — when True, deletes child databases and tables

Example

client.delete_lake("analytics", cascade=True)

show_lakes

show_lakes(*, timeout=None, poll_interval=None)

Example

result = client.show_lakes()