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 safe_drinking_water_facilities_information_system table in this repository, by referencing it like:
"pa-gov/safe-drinking-water-facilities-information-system-afhy-him4:latest"."safe_drinking_water_facilities_information_system"or in a full query, like:
SELECT
":id", -- Socrata column ID
"latitude", -- This is a latitudinal generic point central to each county to help create map visualizations by county. The only purpose is to assist in creating a mapping visual for a county. No other meaning is associated with this generic latitudinal point.
"servedfipscounty", -- A county served by the PA Water System identified by FIPS coding. This is the 5-digit Federal Information Processing Standard (FIPS) code. Each State has its own 2-digit number and each County within the state has its own 3-digit number which are combined into a 5-digit number to uniquely identify every US county. For more technical details : Federal Information Processing Standards Publications (FIPS PUBS) are issued by the National Institute of Standards and Technology (NIST) after approval by the Secretary of Commerce pursuant to Section 111 (d) of the Federal Property and Administrative Services Act of 1949 as amended by the Computer Security Act of 1987, Public Law 100-235. Federal Information Processing Standard (FIPS) 6-4, Counties and Equivalent Entities of the U.S., Its Possessions, and Associated Areas -- 90 Aug 31 , provides the names and codes that represent the counties and other entities treated as equivalent legal and/or statistical subdivisions of the 50 States, the District of Columbia, and the possessions and freely associated areas of the United States. Counties are considered to be the "first-order subdivisions" of each State and statistically equivalent entity, regardless of their local designations (county, parish, borough, etc.). Information gathered from census data - https://www.census.gov/library/reference/code-lists/ansi.html. The last 3-digit part of the 5-digit county FIPS code specifically standing for the county.
"pwsdeactivationdate", -- The date in which the water system was reported as being closed/deactivated, meaning the activity code is changed to Inactive. Must be valued if Activity Flag set to I-Inactive. May not be valued if Activity Flag set to A-Active.
"sdwaservicearea", -- A service area defines the sensitive populations that receive water from the water system. Values - Day Care Center, Dispenser, Homeowners Association, Hotel/Motel, Highway Rest Area, Industrial/Agricultural, Interstate Carrier, Institution, Medical Facility, Mobile Home Park, Mobile Home Park Principle Residence, Municipality, Other Area, Other Non-Transient Area, Other Residential Area, Other Transient Area, Recreation Area, Residential Area, Retail Employees, Restaurant, School, Sanitary Improvement District, Summer Camp, Secondary Residences, Service Station, Subdivision, Water Bottler Wholesale
"facilitytoidentifier", -- A state-assigned value which identifies the water system facility to which the water flows. The Facility ID shall be alphanumeric text, which may contain numbers (0 - 9), letters (A - Z), special characters (e.g., &, #, %).
"sourcefacilitysellerpwsiden", -- PWSID of the water system that is selling water to this system through this interconnection. Is also the "upstream" water system to the parent of this facility.
"sdwasourcefacilitytype", -- Code that Indicates the source type of the water system facility. Values - Consecutive Connection, Infiltration Gallery, Intake, Non-piped - non-purchased, Non-piped, Roof Catchment, Reservoir, Spring, Well (Source)
"sourcefacilitynametext", -- Name of source for the water system facility.
"otherfacilitynametext", -- Name of additional, i.e., other, water system facility when multiple facilities exist for the water system at different physical locations. A coded value which categorizes the water facility. The code specifies the type of source, plant, or entry point facility (e.g., WL is a well which is a type of source).
"pwsidentifier", -- Uniquely identifies the water system within Pennsylvania. Format: PAXXXXXXXXXX where: PA = the Federal Information Processing Standard (FIPS) Pub 5-2 State abbreviation for Pennsylvania, the state where the water system is located, or the region number of the EPA region responsible for an Indian reservation, and XXXXXXXXXX = the water system identification code assigned by Pennsylvania.
"sdwasourcefacilitywatertype", -- Indicates the type of the water of the source. Values - No info provided, surface water, Ground Water, ground water under the influence of surface water
"facilityfromidentifier", -- A state-assigned value which identifies the water system facility from which water flows. The Facility ID shall be alphanumeric text, which may contain numbers (0 - 9), letters (A - Z), special characters (e.g., &, #, %).
"sdwasourcefacilityavailabil", -- Code for how the source water is utilized by a water system. Values - permanent, other, emergency, seasonal, interim
"facilitydeactivationdate", -- Date when the water system was deactivated (water no longer actively serving water) or removed from federal oversight because it no longer met SDWA(safe drinking water) criteria as a public water system.
"sdwaownertype", -- Code that identifies the ownership category of the water system. Private,Local Government, Public/Private, Federal Government, State Government, Native American
"treatmentplantfacilitynamet", -- Name of the treatment plant of the water system facility.
"pwsfacilityidentifier", -- Water system facility ID that, when used with the PA Water System Identifier, uniquely identifies a water system facility.
"retailserviceconnectionsvalue", -- Number of service connections to the water system. An example would be a restaurant having a source and the number of connections it is providing. Other examples are the number of businesses or homes connected.
"sdwapwstype", -- Classifies the type of water system according to federal requirements. Community Water Systems, Non-Transient Non-Community Water Systems, for example restaurants Transient Non-Community Water Systems.
"served_county_code", -- A County served by the Public Water System identified by state coding. County code according to state. String from '01' to '67' or blank if not entered. In the Filtered View this column is used as the Count column by Water System by County.
"sdwaotherfacilitytype", -- Code that Indicates additional categorization about the type of water system facility.
"servedcounty", -- The County name served by the PA Water System Identified by state coding.
"pwsnametext", -- The name of the water system. The name can be the formal, legal, or common name that is used most generally in referring to the water system. When multiple facilities exist for the water system at different physical locations, the name identifies the means by which the system, as a whole, is generally known.
"sdwasourcefacilitysellertre", -- Code that indicates whether the seller is or is not treating the source or whether the seller treatment status is unknown. Applies only to source facilities. Values - No info provided, seller is treating the source, seller is not treating the source
"sdwasourcefacilityreported", -- A code reported by the state to indicate whether a non-emergency surface water source or a non-emergency ground water under the influence of surface water source is required to install filtration by a certain date or is successfully avoiding filtration. Values - install filtration by a certain date, successfully avoiding filtration
"sdwatreatmentfacilitytype", -- Code that Indicates the treatment type used in the water system facility. Note: Only type “TP” for Treatment Plant can be reported on this object.
"sdwaactivity", -- Code that indicates the activity status of the public water system. The system is Active if at least 25 people or 15 connections have access. Inactive is assigned when either the user(s) are out of business or the system has been merged into another or its not servicing any.
":@computed_region_rayf_jjgk",
":@computed_region_r6rf_p9et",
":@computed_region_amqz_jbr4",
":@computed_region_d3gw_znnf",
":@computed_region_nmsq_hqvv",
"sdwafacilityactivity", -- The value of this attribute indicates the status of the facility. Active or Inactive
"legal_state_entity_name", -- The state of a legal entity, such as an individual, corporation, or government agency. One of 50 state names.
"retailpopulationservedvalue", -- Water system’s estimate of the number of people served by the system.
"longitude", -- This is a longitudinal generic point central to each county to help create map visualizations by county. The only purpose is to assist in creating a mapping visual for a county. No other meaning is associated with this generic latitudinal point.
"geocoded_column" -- The is a generic Georeferenced column created from the 2-county central generic latitudinal & Longitudinal columns that can be used in creating mapping visualizations by using these generic, central, latitudinal and longitudinal points within each county. The only purpose is for creating a mapping visual for a county. No other meaning is associated with these georeferenced points.
FROM
"pa-gov/safe-drinking-water-facilities-information-system-afhy-him4:latest"."safe_drinking_water_facilities_information_system"
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 pa-gov/safe-drinking-water-facilities-information-system-afhy-him4 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 pa-gov/safe-drinking-water-facilities-information-system-afhy-him4: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 pa-gov/safe-drinking-water-facilities-information-system-afhy-him4Checkout 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 pa-gov/safe-drinking-water-facilities-information-system-afhy-him4:latestThis will download all the objects for the latest tag of pa-gov/safe-drinking-water-facilities-information-system-afhy-him4 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 pa-gov/safe-drinking-water-facilities-information-system-afhy-him4: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 pa-gov/safe-drinking-water-facilities-information-system-afhy-him4: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, pa-gov/safe-drinking-water-facilities-information-system-afhy-him4 is just another Postgres schema.