steampipe plugin install vercelsteampipe plugin install vercel

Vercel + Steampipe

Vercel is a cloud hosting service for frontend frameworks and static sites.

Steampipe is an open-source zero-ETL engine to instantly query cloud APIs using SQL.

List projects in your Vercel account:

select
  name,
  framework,
  updated_at
from
  vercel_project;

+------------------+-----------+---------------------------+
| name             | framework | updated_at                |
+------------------+-----------+---------------------------+
| my-homepage-io   | nextjs    | 2022-07-12T14:04:42-04:00 |
| another-site-com | nextjs    | 2022-07-12T14:28:38-04:00 |
+------------------+-----------+---------------------------+

Documentation

Table definitions & examples →

Get started

Install

Download and install the latest Vercel plugin:

steampipe plugin install vercel

Configuration

Installing the latest vercel plugin will create a config file (~/.steampipe/config/vercel.spc) with a single connection named vercel:

connection "vercel" {
  plugin    = "vercel"
  api_token = "YwbeYCAYfpdPKSj9yd18JUXX"
  team      = "mycompany"
}

api_token - API token to access your account.
team - Optional team to target.

Environment variables are also available as an alternate configuration method:

VERCEL_API_TOKEN
VERCEL_TEAM

Postgres FDW

This plugin is available as a native Postgres FDW. Unlike Steampipe CLI, which ships with an embedded Postgres server instance, the Postgres FDW can be installed in any supported Postgres database version.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_postgres_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/postgres.sh)" -- vercel

The installer will prompt you for the plugin name and version, download and install the appropriate files for your OS, system architecture, and Postgres version.

To configure the Postgres FDW, you will create an extension, foreign server, and schema and import the foreign schema.

CREATE EXTENSION IF NOT EXISTS steampipe_postgres_vercel;
CREATE SERVER steampipe_vercel FOREIGN DATA WRAPPER steampipe_postgres_vercel OPTIONS (config '<your_config>');
CREATE SCHEMA vercel;
IMPORT FOREIGN SCHEMA vercel FROM SERVER steampipe_vercel INTO vercel;

SQLite Extension

This plugin is available as a SQLite Extension, making the tables available as SQLite virtual tables.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_sqlite_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/sqlite.sh)" -- vercel

The installer will prompt you for the plugin name, version, and destination directory. It will then determine the OS and system architecture, and it will download and install the appropriate package.

To configure the SQLite extension, load the extension module and then run the steampipe_configure_vercel function to configure it with plugin-specific options.

$ sqlite3
sqlite> .load ./steampipe_sqlite_extension_vercel.so
sqlite> select steampipe_configure_vercel('<your_config>');

Export

This plugin is available as a standalone Export CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- vercel

You can pass the configuration to the command with the --config argument:

steampipe_export_vercel --config '<your_config>' <table_name>