bauplan.schema
class APIError
class APIMetadata
class APIResponse
class APIResponseWithData
class APIResponseWithError
class Actor
class Branch
class CacheDir
EXPERIMENTAL AND SUBJECT TO CHANGE.
CacheDir is a model for a standard bauplan directory ($HOME/.bauplan) for caching of files on the local filesystem. This is partially a convenience interface for other models such as JobContext, and partially a convenience for the user to easily clean up any cache files they no longer want (or a previous process failed to clean up).
def cleanup
Parameters
def clear_job_cache
Remove all directories with the '.job_snapshot' prefix from the bauplan cache.
Parameters
base_dirpath Path
def save
Parameters
class Commit
class DAGEdge
A dependency between DAGNode instances, representing dataflow.
class DAGNode
A bauplan function that produces a Model.
class DetachedRef
class Entry
class GetBranchesResponse
Parameters
data_fetcher Callable[[int, Optional[str]], APIResponse]
data_mapper Callable[[Dict[str, Any]], T]
itersize int
limit int | None
class GetCommitsResponse
Parameters
data_fetcher Callable[[int, Optional[str]], APIResponse]
data_mapper Callable[[Dict[str, Any]], T]
itersize int
limit int | None
class GetNamespacesResponse
Parameters
data_fetcher Callable[[int, Optional[str]], APIResponse]
data_mapper Callable[[Dict[str, Any]], T]
itersize int
limit int | None
class GetTablesResponse
Parameters
data_fetcher Callable[[int, Optional[str]], APIResponse]
data_mapper Callable[[Dict[str, Any]], T]
itersize int
limit int | None
class GetTagsResponse
Parameters
data_fetcher Callable[[int, Optional[str]], APIResponse]
data_mapper Callable[[Dict[str, Any]], T]
itersize int
limit int | None
class Job
EXPERIMENTAL AND SUBJECT TO CHANGE.
Job is a model for a job in the Bauplan system. It is tracked as a result of a code snapshot run.
def finished_after
Check if the job finished within the given timedelta from now.
Parameters
start datetime
def finished_before
Check if the job finished before the given timedelta from now.
Parameters
end datetime
def finished_between
Check if the job finished between two datetimes.
Parameters
start datetime
end datetime
def from_proto
Parameters
job_pb common_pb.JobInfo
def has_finished_range
Parameters
after_time Optional[datetime]
before_time Optional[datetime]
def has_id
Check if the job has the specified ID or ID prefix.
Parameters
check_id str
def has_started_range
Check if the job started within the specified time range.
Parameters
after_time Optional[datetime]
before_time Optional[datetime]
def has_status
Check if the job has specified status.
Parameters
check_status Union[str, JobState]
def started_after
Check if the job started after the given datetime.
Parameters
start datetime
def started_before
Check if the job started before the given datetime.
Parameters
end datetime
def started_between
Check if the job started between two datetimes.
Parameters
start datetime
end datetime
class JobContext
EXPERIMENTAL AND SUBJECT TO CHANGE.
JobContext is a model for immediate working context of a particular job. This currently includes: (1) Ref, (2) Code Snapshot, (3) Logs. A JobContext should enable a variety of workflows for iterating on an existing Job.
def cleanup_cache
Parameters
def save_cache
Parameters
class JobKind
Models a job's "kind" or job type. May be one of: UNSPECIFIED, CODE_SNAPSHOT_RUN, QUERY, IMPORT_PLAN_CREATE, IMPORT_PLAN_APPLY, TABLE_PLAN_CREATE, TABLE_PLAN_CREATE_APPLY, or TABLE_IMPORT.
class JobLogEvent
EXPERIMENTAL AND SUBJECT TO CHANGE.
JobLogEvent is a model for a particular log message from a particular job.
When you output logs within a Python model, they are persisted as JobLogEvents.
class JobLogLevel
class JobLogList
EXPERIMENTAL AND SUBJECT TO CHANGE.
JobLogList is a model for all of the logs from a particular job. This model is primarily provided as a convenience for "common" interactions with a job's log messages.
def error_messages
Parameters
class JobLogStream
class JobState
class Namespace
class PartitionField
class Ref
A branch or a tag