mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-09-05 16:03:47 +00:00
chore(datatables): regenerate cli/system-prompt docs for the datatable role param
This commit is contained in:
Generated
+12
-4
@@ -1102,6 +1102,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -1112,7 +1114,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = \${name} AND age = \${age}::int
|
||||
* \`.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
@@ -1885,6 +1887,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -1895,7 +1899,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = \${name} AND age = \${age}::int
|
||||
* \`.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
@@ -2762,6 +2766,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -2772,7 +2778,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = \${name} AND age = \${age}::int
|
||||
* \`.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
@@ -4373,10 +4379,12 @@ def send_teams_message(conversation_id: str, text: str, success: bool = True, ca
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main')
|
||||
def datatable(name: str = 'main', role: Optional[str] = None)
|
||||
|
||||
# Get a DuckLake client for DuckDB queries.
|
||||
#
|
||||
|
||||
@@ -1414,7 +1414,7 @@ class Windmill:
|
||||
Args:
|
||||
name: Database name (default: "main")
|
||||
role: DataTable role to run as, on a datatable with permissions
|
||||
enabled (default: the "root" role)
|
||||
enabled (default: the data table's default role)
|
||||
|
||||
Returns:
|
||||
DataTableClient instance
|
||||
@@ -2248,7 +2248,7 @@ def datatable(name: str = "main", role: Optional[str] = None) -> DataTableClient
|
||||
Args:
|
||||
name: Database name (default: "main")
|
||||
role: DataTable role to run as, on a datatable with permissions
|
||||
enabled (default: the "root" role)
|
||||
enabled (default: the data table's default role)
|
||||
|
||||
Returns:
|
||||
DataTableClient instance
|
||||
@@ -2338,7 +2338,7 @@ class DataTableClient:
|
||||
client: Windmill client instance
|
||||
name: DataTable name
|
||||
role: DataTable role to run as, on a datatable with permissions
|
||||
enabled (default: the "root" role)
|
||||
enabled (default: the data table's default role)
|
||||
"""
|
||||
self.client = client
|
||||
self.role = role
|
||||
|
||||
@@ -1800,6 +1800,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -1810,7 +1812,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = \${name} AND age = \${age}::int
|
||||
* \`.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
@@ -2317,10 +2319,12 @@ def send_teams_message(conversation_id: str, text: str, success: bool = True, ca
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main')
|
||||
def datatable(name: str = 'main', role: Optional[str] = None)
|
||||
|
||||
# Get a DuckLake client for DuckDB queries.
|
||||
#
|
||||
@@ -2964,6 +2968,8 @@ interface DatatableSqlTemplateFunction {
|
||||
|
||||
Create a SQL template function for PostgreSQL/datatable queries
|
||||
@param name - Database/datatable name (default: "main")
|
||||
@param role - Data table role to run as, on a datatable with permissions
|
||||
enabled (default: the data table's default role)
|
||||
@returns SQL template function for building parameterized queries
|
||||
@example
|
||||
let sql = wmill.datatable()
|
||||
@@ -2974,7 +2980,8 @@ await sql\`
|
||||
WHERE name = \${name} AND age = \${age}::int
|
||||
\`.fetch()
|
||||
\`\`\`typescript
|
||||
function datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
function datatable(name: string = "main",
|
||||
role?: string): DatatableSqlTemplateFunction
|
||||
\`\`\`
|
||||
`;
|
||||
|
||||
@@ -2986,10 +2993,12 @@ Import: \`import wmill\`
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main') -> DataTableClient
|
||||
def datatable(name: str = 'main', role: Optional[str] = None) -> DataTableClient
|
||||
|
||||
# Client for executing SQL queries against Windmill DataTables.
|
||||
class DataTableClient:
|
||||
@@ -2998,7 +3007,9 @@ class DataTableClient:
|
||||
# Args:
|
||||
# client: Windmill client instance
|
||||
# name: DataTable name
|
||||
def __init__(client: Windmill, name: str)
|
||||
# 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.
|
||||
#
|
||||
|
||||
@@ -1992,6 +1992,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -2002,7 +2004,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = ${name} AND age = ${age}::int
|
||||
* `.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
@@ -2509,10 +2511,12 @@ def send_teams_message(conversation_id: str, text: str, success: bool = True, ca
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main')
|
||||
def datatable(name: str = 'main', role: Optional[str] = None)
|
||||
|
||||
# Get a DuckLake client for DuckDB queries.
|
||||
#
|
||||
|
||||
@@ -6,10 +6,12 @@ Import: `import wmill`
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main') -> DataTableClient
|
||||
def datatable(name: str = 'main', role: Optional[str] = None) -> DataTableClient
|
||||
|
||||
# Client for executing SQL queries against Windmill DataTables.
|
||||
class DataTableClient:
|
||||
@@ -18,7 +20,9 @@ class DataTableClient:
|
||||
# Args:
|
||||
# client: Windmill client instance
|
||||
# name: DataTable name
|
||||
def __init__(client: Windmill, name: str)
|
||||
# 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.
|
||||
#
|
||||
|
||||
@@ -62,6 +62,8 @@ interface DatatableSqlTemplateFunction {
|
||||
|
||||
Create a SQL template function for PostgreSQL/datatable queries
|
||||
@param name - Database/datatable name (default: "main")
|
||||
@param role - Data table role to run as, on a datatable with permissions
|
||||
enabled (default: the data table's default role)
|
||||
@returns SQL template function for building parameterized queries
|
||||
@example
|
||||
let sql = wmill.datatable()
|
||||
@@ -72,5 +74,6 @@ await sql`
|
||||
WHERE name = ${name} AND age = ${age}::int
|
||||
`.fetch()
|
||||
```typescript
|
||||
function datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
function datatable(name: string = "main",
|
||||
role?: string): DatatableSqlTemplateFunction
|
||||
```
|
||||
|
||||
@@ -461,10 +461,12 @@ def send_teams_message(conversation_id: str, text: str, success: bool = True, ca
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main')
|
||||
def datatable(name: str = 'main', role: Optional[str] = None)
|
||||
|
||||
# Get a DuckLake client for DuckDB queries.
|
||||
#
|
||||
|
||||
@@ -557,6 +557,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -567,7 +569,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = ${name} AND age = ${age}::int
|
||||
* `.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
|
||||
@@ -728,6 +728,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -738,7 +740,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = ${name} AND age = ${age}::int
|
||||
* `.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
|
||||
@@ -728,6 +728,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -738,7 +740,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = ${name} AND age = ${age}::int
|
||||
* `.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
|
||||
@@ -730,6 +730,8 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
/**
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
@@ -740,7 +742,7 @@ parseS3Object(s3Object: S3Object): S3ObjectRecord
|
||||
* WHERE name = ${name} AND age = ${age}::int
|
||||
* `.fetch()
|
||||
*/
|
||||
datatable(name: string = "main"): DatatableSqlTemplateFunction
|
||||
datatable(name: string = "main", role?: string): DatatableSqlTemplateFunction
|
||||
|
||||
/**
|
||||
* Create a SQL template function for DuckDB/ducklake queries
|
||||
|
||||
@@ -646,10 +646,12 @@ def send_teams_message(conversation_id: str, text: str, success: bool = True, ca
|
||||
#
|
||||
# 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
|
||||
def datatable(name: str = 'main')
|
||||
def datatable(name: str = 'main', role: Optional[str] = None)
|
||||
|
||||
# Get a DuckLake client for DuckDB queries.
|
||||
#
|
||||
|
||||
@@ -333,7 +333,7 @@ function buildSqlTemplateFunction(provider: SqlProvider): SqlTemplateFunction {
|
||||
* Create a SQL template function for PostgreSQL/datatable queries
|
||||
* @param name - Database/datatable name (default: "main")
|
||||
* @param role - Data table role to run as, on a datatable with permissions
|
||||
* enabled (default: the "root" role)
|
||||
* enabled (default: the data table's default role)
|
||||
* @returns SQL template function for building parameterized queries
|
||||
* @example
|
||||
* let sql = wmill.datatable()
|
||||
|
||||
Reference in New Issue
Block a user