bauplan.state

---

classExternalTableCreateContextNon-instantiable

Attributes

branch_name:

str

namespace:

str

table_name:

str

---

classExternalTableCreateStateNon-instantiable

Attributes

ctx:

ExternalTableCreateContext

error:

str | None

job_id:

str | None

job_status:

str | None

---

classRunExecutionContextNon-instantiable

The execution context for a run, capturing the parameters that were used to launch it.

Attributes

cache:

str

debug:

bool

detach:

bool

dry_run:

bool

namespace:

str

preview:

str

project_dir:

str

ref:

str

snapshot_id:

str

snapshot_uri:

str

strict:

str

transaction:

str

---

classRunStateNon-instantiable

The state of a completed (or failed) run, including logs, timing, and per-task lifecycle events.

Attributes

ctx:

RunExecutionContext

The execution context for the run.

duration:

float | None

Duration in seconds, or None if the run hasn't ended.

duration_ns:

int | None

Duration in nanoseconds, or None if the run hasn't ended.

ended_at_ns:

int | None

Epoch nanoseconds when the run ended, if it has.

error:

str | None

Error message, if the run failed.

job_id:

str | None

The job ID assigned by the server.

job_status:

str | None

The final status string (e.g. "SUCCESS", "FAILED").

started_at_ns:

int

Epoch nanoseconds when the run started.

tasks_started:

dict[str, datetime]

Per-task start times, keyed by task ID.

tasks_stopped:

dict[str, datetime]

Per-task stop times, keyed by task ID.

user_logs:

list[JobLogEvent]

User log messages emitted during the run.

---

classTableCreatePlanApplyStateNon-instantiable

Attributes

error:

str | None

job_id:

str | None

job_status:

str | None

---

classTableCreatePlanContextNon-instantiable

Attributes

branch_name:

str

namespace:

str

search_string:

str

table_name:

str

table_partitioned_by:

str | None

table_replace:

bool

---

classTableCreatePlanStateNon-instantiable

The result of a plan_table_creation call.

The plan field contains the schema plan as a YAML string. You can modify it before applying, for example to add partitioning:

import bauplan
import yaml

client = bauplan.Client()
plan_state = client.plan_table_creation('my_table', 's3://bucket/path/*.parquet')
plan = yaml.safe_load(plan_state.plan)
plan['schema_info']['partitions'] = [
    {
        'from_column_name': 'datetime_column',
        'transform': {'name': 'year'},
    }
]
modified_plan = yaml.dump(plan)

Attributes

can_auto_apply:

bool

ctx:

TableCreatePlanContext

error:

str | None

files_to_be_imported:

list[str]

job_id:

str | None

job_status:

str | None

plan:

str | None

---

classTableDataImportContextNon-instantiable

Attributes

best_effort:

bool

branch_name:

str

continue_on_error:

bool

import_duplicate_files:

bool

namespace:

str

preview:

str

search_string:

str

table_name:

str

transformation_query:

str | None

---

classTableDataImportStateNon-instantiable

The state of a completed data import job.

Attributes

ctx:

TableDataImportContext

error:

str | None

job_id:

str | None

job_status:

str | None