sql.from() function

The sql.from() function retrieves data from a SQL data source.

Function type: Input

import "sql"

sql.from(
  driverName: "postgres",
  dataSourceName: "postgresql://user:password@localhost",
  query:"SELECT * FROM TestTable"
)

Parameters

driverName

The driver used to connect to the SQL database.

Data type: String

The following drivers are available:

  • mysql
  • postgres
  • sqlite3 – Does not work with InfluxDB OSS, InfluxDB Enterprise, or InfluxDB Cloud. More information below.

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.

Data type: String

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

# SQLite Driver DSN
file:/path/to/test.db?cache=shared&mode=ro

query

The query to run against the SQL database.

Data type: String

Examples

Query a MySQL database

import "sql"

sql.from(
 driverName: "mysql",
 dataSourceName: "user:password@tcp(localhost:3306)/db",
 query:"SELECT * FROM example_table"
)

Query a Postgres database

import "sql"

sql.from(
  driverName: "postgres",
  dataSourceName: "postgresql://user:password@localhost",
  query:"SELECT * FROM example_table"
)

Query an SQLite database

InfluxDB OSS and InfluxDB Cloud do not have direct access to the local filesystem and cannot query SQLite data sources. Use the Flux REPL to query a SQLite data source on your local filesystem.

import "sql"
sql.from(
  driverName: "sqlite3",
  dataSourceName: "file:/path/to/test.db?cache=shared&mode=ro",
  query:"SELECT * FROM example_table"
)

This documentation is open source. See a typo? Please, open an issue.


Need help getting up and running? Get Support