Query the Data Delivery Network
Query the DDNThe 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 statewide_commercial_baseline_study_of_new_york table in this repository, by referencing it like:
"ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d:latest"."statewide_commercial_baseline_study_of_new_york"or in a full query, like:
SELECT
":id", -- Socrata column ID
"survey_type_situation_metric", -- Describes how the survey for the situation metric was completed; either Site, Phone/Site or Phone. Blank cells represent data that were not required or are not currently available
"weighted_penetration_pct", -- Weighted penetration of equipment category (between 0 and 1). Blank cells represent data that were not required or are not currently available
"unweighted_penetration_pct", -- Unweighted penetration of equipment category (between 0 and 1)
"sites_with_enduse_present", -- Total number of respondents who have the equipment category. Blank cells represent data that were not required or are not currently available
"equipment_category", -- Type of equipment; Cooking Equipment, Electric Vehicle, Motors, Water Heater, etc.
"usage_category", -- A categorical variable explaining how much energy the survey site uses; either All Usage, Less Than 75 MWh or 75 MWh and Greater. All Usage represents segments that could not be split by usage category.
"segment", -- The business segment which was surveyed; either Education, Food Service, Grocery_Convenience, Health Services, Health Services/Hospitals, Hospitals, Lodging_Hospitality, Office_Government, Retail, Total, or Warehouse. Total represents the sum off all business segments.
"effective_adjustment_ratio", -- Ratio to adjust phone/web results by on-site results. Blank cells represent data that were not required or are not currently available
"standard_error_of_penetration_pct", -- Standard error of weighted penetration (between 0 and 1). Blank cells represent data that were not required or are not currently available
"question", -- Question number from the survey instrument
"end_use_category", -- Categorical variable describing the largest end-use of electricity for the site surveyed; either Building Characteristics, Building Envelope, Building Spaces, Commercial Kitchen, Compressed Air, District Stream, Electric Vehicles, EMS, Exterior Lighting, HVAC_Controls, HVAC_Cooling, HVAC_Heating, HVAC_Ventilation, Interior Lighting, Maintenance and RCx, Motors, Occupancy Hours, Office Equipment, On-Site Generation, Refrigeration, or Water Heating.
"total_n", -- Total number of respondents
"valid_n", -- Total number of respondents who provided a valid response. Blank cells represent data that were not required or are not currently available
"adjusted_and_weighted_pen_pct", -- Adjusted and Weighted penetration of equipment category. Blank cells represent data that were not required or are not currently available
"unit", -- Definition of widget used in saturation calculation; either Compressors, Computers, Fixtures, Lamps, Nozzles, Server Racks, Servers, Sq Ft, or Widgets. Blank cells represent data that were not required or are not currently available
"valid_n_for_saturation", -- Total number of respondents who provided a valid response to the question. Blank cells represent data that were not required or are not currently available
"valid_quantity_for_saturation", -- Total number of widgets of the equipment category. Blank cells represent data that were not required or are not currently available
"unweighted_saturation", -- Unweighted saturation of equipment category. Blank cells represent data that were not required or are not currently available
"weighted_saturation", -- Weighted saturation of equipment category. Blank cells represent data that were not required or are not currently available
"adjusted_and_weighted_1", -- Weighted and adjusted saturation of equipment category. Blank cells represent data that were not required or are not currently available
"standard_error_of_saturation", -- Standard error of weighted saturation. Blank cells represent data that were not required or are not currently available
"survey_type", -- Describes how the survey for the penetration metric was completed; either Site or Phone
"region" -- The geographic region of NY which was surveyed; either All Regions, Downstate, LI/Hudson Valley, or Upstate. The regions are mutually exclusive; All Regions represents Statewide (not enough information to be able to segment by Downstate, update, LI)
FROM
"ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d:latest"."statewide_commercial_baseline_study_of_new_york"
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 ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d with SQL in under 60 seconds.
Query Your Local Engine
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, 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 (like this repository), where the author has pushed Splitgraph Images to the repository, you can "clone" and/or "checkout" the data using sgr cloneand sgr checkout.
Cloning Data
Because ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d:latest is a Splitgraph Image, you can clone the data from Spltgraph Cloud to your local engine, where you can query it like any other Postgres database, using any of your existing tools.
First, install Splitgraph if you haven't already.
Clone the metadata with sgr clone
This will be quick, and does not download the actual data.
sgr clone ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6dCheckout the data
Once you've cloned the data, you need to "checkout" the tag that you want. For example, to checkout the latest tag:
sgr checkout ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d:latestThis will download all the objects for the latest tag of ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d and load them into the Splitgraph Engine. Depending on your connection speed and the size of the data, you will need to wait for the checkout to complete. Once it's complete, you will be able to query the data like you would any other Postgres database.
Alternatively, use "layered checkout" to avoid downloading all the data
The data in ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d:latest is 0 bytes. If this is too big to download all at once, or perhaps you only need to query a subset of it, you can use a layered checkout.:
sgr checkout --layered ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d:latestThis will not download all the data, but it will create a schema comprised of foreign tables, that you can query as you would any other data. Splitgraph will lazily download the required objects as you query the data. In some cases, this might be faster or more efficient than a regular checkout.
Read the layered querying documentation to learn about when and why you might want to use layered queries.
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, ny-gov/statewide-commercial-baseline-study-of-new-york-umaq-yp6d is just another Postgres schema.