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 ghg_reporting_program_publication table in this repository, by referencing it like:
"wa-gov/ghg-reporting-program-publication-idhm-59de:latest"."ghg_reporting_program_publication"or in a full query, like:
SELECT
":id", -- Socrata column ID
"location", -- GPS coordinates of reporter, if applicable. Reporters without a specific location may not have this field.
"point_size", -- Used to determine the size of the dot on the map. Based on total emissions. Not available for unmapped reporters.
"sulfur_hexafluoride_mtco2e", -- Total reported sulfur hexafluoride emissions in metric tons of carbon dioxide equivalents.
"pfcs_mtco2e", -- Total reported perfluorocarbons emissions in metric tons of carbon dioxide equivalents. This includes several GHGs: https://en.wikipedia.org/wiki/Fluorocarbon
"hfcs_mtco2e", -- Total reported hydrofluorocarbon emissions in metric tons of carbon dioxide equivalents. This includes several GHGs: https://en.wikipedia.org/wiki/Hydrofluorocarbon
"nitrous_oxide_mtco2e", -- Total reported nitrous oxide emissions in metric tons of carbon dioxide equivalents.
"carbon_dioxide_mtco2e", -- Total reported carbon dioxide emissions in metric tons of carbon dioxide equivalents. Does not include biogenic carbon dioxide.
"jurisdiction", -- Normal permitting authority for reporter, if applicable. All GHG reporting is implemented by Ecology's Climate Policy Section. Reporters without a specific location may not have this field.
"county", -- County of reporter, if applicable. Reporters without a specific location may not have this field.
"city", -- City of reporter, if applicable. Reporters without a specific location may not have this field.
"parent_company", -- Highest USA parent company.
"naics_definition", -- https://www.census.gov/naics
"subsector", -- Secondary activity classification of the reporter.
"sector", -- Main activity classification of the reporter.
"year", -- Calendar year that emissions occurred.
"facility", -- Name of reporters reporting emissions.
"biogenic_carbon_dioxide_mtco2e", -- Total reported biogenic carbon dioxide emissions in metric tons of carbon dioxide equivalents. Examples: wood, biodiesel, or biogas combustion.
"total_emissions_mtco2e", -- Total reported emissions in metric tons of carbon dioxide equivalents. Sum of all other emissions numbers.
"primary_naics_code", -- Main reported North American Industry Classification System (NAICS) code: https://www.census.gov/naics
"notes", -- Details on any unique features of a report. Can denote compliance status, start or end date of reporting, or if Ecology had to assign emissions to the reporter for any reason.
"methane_mtco2e", -- Total reported methane emissions in metric tons of carbon dioxide equivalents.
"geocoded_column", -- Used to create online map. See location field for coordinates.
"fluorinated_other_mtco2e", -- Total reported emissions of GHGs not included in another category, in metric tons of carbon dioxide equivalents.
":@computed_region_8ddd_yn5v",
":@computed_region_fny7_vc3j",
":@computed_region_x4ys_rtnd"
FROM
"wa-gov/ghg-reporting-program-publication-idhm-59de:latest"."ghg_reporting_program_publication"
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 wa-gov/ghg-reporting-program-publication-idhm-59de with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.wa.gov. When you querywa-gov/ghg-reporting-program-publication-idhm-59de: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
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.wa.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 \
"wa-gov/ghg-reporting-program-publication-idhm-59de" \
--handler-options '{
"domain": "data.wa.gov",
"tables": {
"ghg_reporting_program_publication": "idhm-59de"
}
}'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, wa-gov/ghg-reporting-program-publication-idhm-59de is just another Postgres schema.