TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Class SQL

    Index

    Constructors

    Methods

    • Creates a new TagoSQL query on your profile.

      Parameters

      Returns Promise<SQLInfo>

      const result = await Resources.sql.create({
      name: "Latest temperature",
      query: "SELECT variable, value, time FROM device($1) AS d WHERE variable = 'temperature' ORDER BY time DESC LIMIT 10",
      params: [{ key: "$1", value: "my-device-id" }],
      });
      console.log(result); // { id: 'query-id-123', name: 'Latest temperature', ... }
    • Replaces a TagoSQL query. The query is re-validated and its cached results are dropped; a new version is stored when the query or the params change.

      Parameters

      Returns Promise<SQLInfo>

      const result = await Resources.sql.edit("query-id-123", {
      name: "Latest temperature",
      query: "SELECT variable, value, time FROM device($1) AS d ORDER BY time DESC LIMIT 20",
      params: [{ key: "$1", value: "my-device-id" }],
      });
      console.log(result); // { id: 'query-id-123', version: 2, ... }
    • Retrieves a historical snapshot (query and params) of a TagoSQL query. To restore it, send the snapshot's query and params back with edit.

      Parameters

      • sqlID: string
      • version: number

      Returns Promise<SQLVersionInfo>

      const result = await Resources.sql.getVersion("query-id-123", 1);
      console.log(result); // { query: 'SELECT ...', params: [], created_at: ... }
    • Retrieves detailed information about a specific TagoSQL query.

      Parameters

      • sqlID: string

      Returns Promise<SQLInfo>

      If receive an error "Authorization Denied", check policy SQL Query / Access in Access Management.

      const result = await Resources.sql.info("query-id-123");
      console.log(result); // { id: 'query-id-123', name: 'My query', query: 'SELECT ...', ... }
    • Lists all TagoSQL queries from your profile with pagination support.

      Parameters

      Returns Promise<SQLInfo[]>

      If receive an error "Authorization Denied", check policy SQL Query / Access in Access Management.

      const result = await Resources.sql.list({
      page: 1,
      fields: ["id", "name", "tags"],
      amount: 20,
      });
      console.log(result); // [ { id: 'query-id-123', name: 'My query', tags: [] } ]