3.1 KiB
3.1 KiB
title | description | aliases | menu | weight | flux/v0.x/tags | introduced | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sql.to() function | The `sql.to()` function writes data to a SQL database. |
|
|
202 |
|
0.35.0 |
The sql.to()
function writes data to a SQL database.
import "sql"
sql.to(
driverName: "mysql",
dataSourceName: "username:password@tcp(localhost:3306)/dbname?param=value",
table: "example_table",
batchSize: 10000,
)
Parameters
driverName
The driver used to connect to the SQL database.
The following drivers are available:
- bigquery
- hdb
- mysql
- postgres
- snowflake
- sqlite3 – Does not work with InfluxDB OSS or InfluxDB Cloud. For more information, see Write to SQLite.
- sqlserver
- vertica, vertigo
{{% warn %}}
sql.to does not support Amazon Athena
The sql.to
function does not support writing data to Amazon Athena.
{{% /warn %}}
dataSourceName
The data source name (DSN) or connection string used to connect to the SQL database. The string's form and structure depend on the driver used.
Driver dataSourceName examples
# Postgres Driver DSN
postgres://pqgotest:password@localhost/pqgotest?sslmode=verify-full
# MySQL Driver DSN
username:password@tcp(localhost:3306)/dbname?param=value
# Snowflake Driver DSNs
username[:password]@accountname/dbname/schemaname?param1=value1¶mN=valueN
username[:password]@accountname/dbname?param1=value1¶mN=valueN
username[:password]@hostname:port/dbname/schemaname?account=<your_account>¶m1=value1¶mN=valueN
# SQLite Driver DSN
file:/path/to/test.db?cache=shared&mode=rw
# Microsoft SQL Server Driver DSNs
sqlserver://username:password@localhost:1234?database=examplebdb
server=localhost;user id=username;database=examplebdb;
server=localhost;user id=username;database=examplebdb;azure auth=ENV
server=localhost;user id=username;database=examplebdbr;azure tenant id=77e7d537;azure client id=58879ce8;azure client secret=0123456789
# Google BigQuery DSNs
bigquery://projectid/?param1=value¶m2=value
bigquery://projectid/location?param1=value¶m2=value
# SAP HANA driver DSN
hdb://<user>:<password>@<host>:<port>?<connection-property>=<value>&<connection-property>=<value>&...
hdb://<user>:<password>@<host>:<port>?DATABASENAME=<tenant-db-name>
hdb://?KEY=<keyname>
# Vertica driver DSN
vertica://<user>:<password>@<host>:<port>/<database>?<queryArgs>
table
The destination table.
batchSize
The number of parameters or columns that can be queued within each call to Exec
.
Defaults to 10000
.
{{% note %}}
If writing to a SQLite database, set batchSize
to 999
or less.
{{% /note %}}
Examples
For examples and more information about each supported SQL database, see Write to SQL databases.