connections
- POSTTest database connection configuration
- GETList project database connections
- GETGet connection details
- GETTest existing project connection
- GETGet SQL source (deprecated)deprecated
- POSTCreate SQL source from statement
- GETGet table source information
- GETList tables in database schema
- GETList database schemas
- GETExecute SQL query (deprecated)deprecated
- POSTExecute SQL query
- GETCreate temporary table (deprecated)deprecated
- POSTCreate temporary table
projects
packages
queryresults
databases
schedules
A valid request URL is required to generate request examples{
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"type": "postgres",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>"
}
]
}Update project configuration
Updates the configuration and metadata of an existing project. This allows you to modify project settings, update the README, change the location, or update other project-level properties. The project must exist and be accessible.
A valid request URL is required to generate request examples{
"resource": "<string>",
"name": "<string>",
"readme": "<string>",
"location": "<string>",
"connections": [
{
"resource": "<string>",
"name": "<string>",
"type": "postgres",
"attributes": {
"dialectName": "<string>",
"isPool": true,
"canPersist": true,
"canStream": true
},
"postgresConnection": {
"host": "<string>",
"port": 123,
"databaseName": "<string>",
"userName": "<string>",
"password": "<string>",
"connectionString": "<string>"
},
"bigqueryConnection": {
"defaultProjectId": "<string>",
"billingProjectId": "<string>",
"location": "<string>",
"serviceAccountKeyJson": "<string>",
"maximumBytesBilled": "<string>",
"queryTimeoutMilliseconds": "<string>"
},
"snowflakeConnection": {
"account": "<string>",
"username": "<string>",
"password": "<string>",
"warehouse": "<string>",
"database": "<string>",
"schema": "<string>",
"responseTimeoutMilliseconds": 123
},
"trinoConnection": {
"server": "<string>",
"port": 123,
"catalog": "<string>",
"schema": "<string>",
"user": "<string>",
"password": "<string>"
},
"mysqlConnection": {
"host": "<string>",
"port": 123,
"database": "<string>",
"user": "<string>",
"password": "<string>"
}
}
],
"packages": [
{
"resource": "<string>",
"name": "<string>",
"description": "<string>",
"location": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Name of the project Standard identifier pattern for resource names
Body
Represents a Malloy project containing packages, connections, and other resources
Resource path to the project
Project name
Project README content
Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
List of database connections configured for this project
Show child attributes
Show child attributes
Resource path to the connection
Name of the connection
Type of database connection
postgres, bigquery, snowflake, trino, mysql Connection capabilities and configuration attributes
Show child attributes
Show child attributes
SQL dialect name for the connection
Whether the connection uses connection pooling
Whether the connection supports persistent storage operations
Whether the connection supports streaming query results
PostgreSQL database connection configuration
Show child attributes
Show child attributes
PostgreSQL server hostname or IP address
PostgreSQL server port number
Name of the PostgreSQL database
PostgreSQL username for authentication
PostgreSQL password for authentication
Complete PostgreSQL connection string (alternative to individual parameters)
Google BigQuery database connection configuration
Show child attributes
Show child attributes
Default BigQuery project ID for queries
BigQuery project ID for billing purposes
BigQuery dataset location/region
JSON string containing Google Cloud service account credentials
Maximum bytes to bill for query execution (prevents runaway costs)
Query timeout in milliseconds
Snowflake database connection configuration
Show child attributes
Show child attributes
Snowflake account identifier
Snowflake username for authentication
Snowflake password for authentication
Snowflake warehouse name
Snowflake database name
Snowflake schema name
Query response timeout in milliseconds
Trino database connection configuration
Show child attributes
Show child attributes
Trino server hostname or IP address
Trino server port number
Trino catalog name
Trino schema name
Trino username for authentication
Trino password for authentication
MySQL database connection configuration
Show child attributes
Show child attributes
MySQL server hostname or IP address
MySQL server port number
Name of the MySQL database
MySQL username for authentication
MySQL password for authentication
Response
Returns the project updated
Represents a Malloy project containing packages, connections, and other resources
Resource path to the project
Project name
Project README content
Project location, can be an absolute path or URI (e.g. github, s3, gcs, etc.)
List of database connections configured for this project
Show child attributes
Show child attributes
Resource path to the connection
Name of the connection
Type of database connection
postgres, bigquery, snowflake, trino, mysql Connection capabilities and configuration attributes
Show child attributes
Show child attributes
SQL dialect name for the connection
Whether the connection uses connection pooling
Whether the connection supports persistent storage operations
Whether the connection supports streaming query results
PostgreSQL database connection configuration
Show child attributes
Show child attributes
PostgreSQL server hostname or IP address
PostgreSQL server port number
Name of the PostgreSQL database
PostgreSQL username for authentication
PostgreSQL password for authentication
Complete PostgreSQL connection string (alternative to individual parameters)
Google BigQuery database connection configuration
Show child attributes
Show child attributes
Default BigQuery project ID for queries
BigQuery project ID for billing purposes
BigQuery dataset location/region
JSON string containing Google Cloud service account credentials
Maximum bytes to bill for query execution (prevents runaway costs)
Query timeout in milliseconds
Snowflake database connection configuration
Show child attributes
Show child attributes
Snowflake account identifier
Snowflake username for authentication
Snowflake password for authentication
Snowflake warehouse name
Snowflake database name
Snowflake schema name
Query response timeout in milliseconds
Trino database connection configuration
Show child attributes
Show child attributes
Trino server hostname or IP address
Trino server port number
Trino catalog name
Trino schema name
Trino username for authentication
Trino password for authentication
MySQL database connection configuration
Show child attributes
Show child attributes
MySQL server hostname or IP address
MySQL server port number
Name of the MySQL database
MySQL username for authentication
MySQL password for authentication
Was this page helpful?