vermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

The easiest way to query any data on Splitgraph is via the "Data Delivery Network" (DDN). The DDN is a single endpoint that speaks the PostgreSQL wire protocol. Any Splitgraph user can connect to it at data.splitgraph.com:5432 and query any version of over 40,000 datasets that are hosted or proxied by Splitgraph.

For example, you can query the total_compensation_and_expenses_fy20152019 table in this repository, by referencing it like:

"vermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu:latest"."total_compensation_and_expenses_fy20152019"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "multiple_record", -- When "Multiple Record" is indicated this means that there is more than one record for the same employee.  This can be the result of that employee changing jobs, being employed in multiple temporary jobs, or moving from one job type to another (e.g., moving from a temporary job to a classified job).
    "department",
    "total_benefits", -- State contribution to Retirement and Social Security, and where applicable Health, Dental, Life, and Long Term Disability Insurance,  and Employee Assistance Program.
    "job_title",
    "total_compensation", -- The sum of "Total Pay," and "Total Benefits." 
    "job_type", -- Classified, Exempt, General Assembly, Temporary, or Contractual
    "total_expenses", -- Includes reimbursement for mileage, meals and other expenses.
    "pay", -- The amount paid to the employee for "standard hours", which for most full-time employees is 2,080 hours per year (some protective service employees have standard hours greater than 2,080).  This includes "regular" pay, paid holidays, sick leave, annual leave, compensatory leave, personal leave,  and paid leave.  Historically, temporary employees were paid only for hours worked - however, as of 2017 temporary employees are also paid for sick leave per 21 V.S.A. § 487. General Assembly members are paid a weekly rate during the legislative session.
    "overtime_units", -- Units used to calculate overtime pay are based on premium and straight-time hours worked, shift differential and the like.  Note: Overtime units cannot the used to determine overtime hours worked.
    "name",
    "agency",
    "other_pay", -- This is a category of payments made to the employee that are not "pay" or "overtime" and includes such items as shift differential, standby, clothing allowance, annual leave payoff (upon retirement or RIF), prior year compensatory leave payoff, etc.
    "overtime_pay", -- This is cash paid for hours worked in excess of defined workday and/or workweek at rates established by law and/or in the applicable Collective Bargaining Agreements. 
    "total_pay", -- The sum of "Pay," "Other Pay," and "Overtime Pay."
    "fiscal_year"
FROM
    "vermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu:latest"."total_compensation_and_expenses_fy20152019"
LIMIT 100;

Connecting to the DDN is easy. All you need is an existing SQL client that can connect to Postgres. As long as you have a SQL client ready, you'll be able to query vermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.vermont.gov. When you queryvermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu:latest on the DDN, we "mount" the repository using the socrata mount handler. The mount handler proxies your SQL query to the upstream data source, translating it from SQL to the relevant language (in this case SoQL).

We also cache query responses on the DDN, but we run the DDN on multiple nodes so a CACHE_HIT is only guaranteed for subsequent queries that land on the same node.

Query Your Local Engine

Install Splitgraph Locally
bash -c "$(curl -sL https://github.com/splitgraph/splitgraph/releases/latest/download/install.sh)"
 

Read the installation docs.

Splitgraph Cloud is built around Splitgraph Core (GitHub), which includes a local Splitgraph Engine packaged as a Docker image. Splitgraph Cloud is basically a scaled-up version of that local Engine. When you query the Data Delivery Network or the REST API, we mount the relevant datasets in an Engine on our servers and execute your query on it.

It's possible to run this engine locally. You'll need a Mac, Windows or Linux system to install sgr, and a Docker installation to run the engine. You don't need to know how to actually use Docker; sgrcan manage the image, container and volume for you.

There are a few ways to ingest data into the local engine.

For external repositories (like this repository), the Splitgraph Engine can "mount" upstream data sources by using sgr mount. This feature is built around Postgres Foreign Data Wrappers (FDW). You can write custom "mount handlers" for any upstream data source. For an example, we blogged about making a custom mount handler for HackerNews stories.

For hosted datasets, where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.

Mounting Data

This repository is an external repository. It's not hosted by Splitgraph. It is hosted by data.vermont.gov, and Splitgraph indexes it. This means it is not an actual Splitgraph image, so you cannot use sgr clone to get the data. Instead, you can use the socrata adapter with the sgr mount command. Then, if you want, you can import the data and turn it into a Splitgraph image that others can clone.

First, install Splitgraph if you haven't already.

Mount the table with sgr mount

sgr mount socrata \
  "vermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu" \
  --handler-options '{
    "domain": "data.vermont.gov",
    "tables": {
        "total_compensation_and_expenses_fy20152019": "69uf-6qeu"
    }
}'

That's it! Now you can query the data in the mounted table like any other Postgres table.

Query the data with your existing tools

Once you've loaded the data into your local Splitgraph engine, you can query it with any of your existing tools. As far as they're concerned, vermont-gov/total-compensation-and-expenses-fy20152019-69uf-6qeu is just another Postgres schema.