Python Datatable API (wmill)

Import: import wmill

Get a DataTable client for SQL queries.

Args:

name: Database name (default: "main")

role: DataTable role to run as, on a datatable with permissions

enabled (default: the data table's default role)

Returns:

DataTableClient instance

Example:

wmill.datatable("main", role="operator")

def datatable(name: str = 'main', role: Optional[str] = None) -> DataTableClient

Client for executing SQL queries against Windmill DataTables.

class DataTableClient: # Initialize DataTableClient. # # Args: # client: Windmill client instance # name: DataTable name # role: DataTable role to run as, on a datatable with permissions # enabled (default: the data table's default role) def init(client: Windmill, name: str, role: Optional[str] = None)

# Execute a SQL query against the DataTable.
# 
# Args:
#     sql: SQL query string with $1, $2, etc. placeholders
#     *args: Positional arguments to bind to query placeholders
# 
# Returns:
#     SqlQuery instance for fetching results
def query(sql: str, *args) -> SqlQuery

Query result handler for DataTable and DuckLake queries.

class SqlQuery: # Initialize SqlQuery. # # Args: # sql: SQL query string # fetch_fn: Function to execute the query def init(sql: str, fetch_fn)

# Execute query and fetch results.
# 
# Args:
#     result_collection: Optional result collection mode
# 
# Returns:
#     Query results
def fetch(result_collection: str | None = None)

# Execute query and fetch first row of results.
# 
# Returns:
#     First row of query results
def fetch_one()

# Execute query and fetch first row of results. Return result as a scalar value.
# 
# Returns:
#     First row of query result as a scalar value
def fetch_one_scalar()

# Execute query and don't return any results.
#         
def execute()

2.0 KiB Raw Blame History