Skip to main content

Drivers & Templates

Available datasource drivers and pre-configured templates.

GET /api/datasource-drivers

Get all available datasource drivers.

Response:

{
"_links": {
"self": { "href": "/api/datasource-drivers" }
},
"_embedded": {
"inf:datasource-driver": [
{
"id": "mysql",
"name": "MySQL",
"description": "MySQL database connection",
"defaultPort": 3306,
"features": ["joins", "subqueries", "transactions"],
"icon": "mysql-icon"
},
{
"id": "postgres",
"name": "PostgreSQL",
"description": "PostgreSQL database connection",
"defaultPort": 5432,
"features": ["joins", "subqueries", "transactions", "json"],
"icon": "postgres-icon"
}
]
},
"start": 0,
"count": 2,
"total": 2
}

Driver Properties:

FieldTypeDescription
idstringDriver identifier
namestringDisplay name
descriptionstringDriver description
defaultPortintegerDefault connection port
featuresarraySupported database features
iconstringIcon identifier

GET /api/datasource-drivers/{id}

Get a specific driver's details.

Response:

{
"id": "mysql",
"name": "MySQL",
"description": "MySQL database connection",
"defaultPort": 3306,
"features": ["joins", "subqueries", "transactions"],
"options": {
"connectionLimit": {
"type": "integer",
"default": 10,
"description": "Maximum concurrent connections"
}
}
}

GET /api/datasource-templates

Get available datasource templates.

Response:

{
"_links": {
"self": { "href": "/api/datasource-templates" }
},
"_embedded": {
"inf:datasource-template": [
{
"id": "mysql-local",
"name": "MySQL Local Development",
"type": "mysql",
"host": "localhost",
"port": 3306,
"database": "app_dev"
},
{
"id": "postgres-docker",
"name": "PostgreSQL Docker",
"type": "postgres",
"host": "postgres",
"port": 5432
}
]
},
"start": 0,
"count": 2,
"total": 2
}

Use Case:

Pre-configured templates for common datasource setups.


GET /api/datasource-templates/{id}

Get a specific template.

Response:

Returns template configuration that can be used to create a new datasource.