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 buprenorphine_dispensation_data_quarter_3_2016 table in this repository, by referencing it like:
"pa-gov/buprenorphine-dispensation-data-quarter-3-2016-6js5-2mjf:latest"."buprenorphine_dispensation_data_quarter_3_2016"or in a full query, like:
SELECT
":id", -- Socrata column ID
"gender", -- Indicates whether data represents both genders (All Genders) or separate values for Males and Females.
"type_of_rate_or_count_measure", -- Identifies whether the Rate or Count Column displays the count of dispensations filled by a dispensary and given to a patient or the Rate of Dispensations per 1000 Residents - calculated using quarterly counts as numerators and county populations as denominators; based on the location of the dispensary
"type_of_drug_class", -- Identifies the group of drugs being reported on - Buprenorphine - data received by the PDMP is restricted to prescriptions filled by pharmacies. The PDMP does not collect information on the reason a controlled substance is prescribed, nor does it collect data from substance abuse treatment facilities or dispensing prescribers providing buprenorphine for substance abuse treatment. Buprenorphine is sometimes prescribed off-label for pain. Dispensation = a prescription that has been filled by a dispensary and given to a patient
"rate_or_count", -- Number of or calculated dispensation rate for each county and PENNSYLVANIA for buprenorphine prescriptions that have been filled by a dispensar and given to a patient
"time_period", -- Timeframe for calculated rate in the format of Year and Calendar Quarter (YYYY QQ)
"quarter_date_start", -- Start date for the Quarter for which the data is being reported
"county_code_number", -- There are 67 counties in Pennsylvania. They are number 01 through 67 in alphabetical order; 00 identifies the statewides totals.
"county_code_text", -- There are 67 counties in Pennsylvania. They are number 01 through 67 in alphabetical order; 00 identifies the statewides totals. This column has the codes formatted as text fields to integrate with other files where county codes are used in place of names and for easier coding within certain software
"state_fips_code", -- These are the first 2 digits of the 5-digit Federal Information Processing Standard (FIPS) code that designate the State association. 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
"county_name", -- Pennsylvania County name; includes PENNSYLVANIA for the statewide rates
"notes", -- Provides information about data suppression.
"county_fips_code", -- The FIPS county code is a five-digit Federal Information Processing Standard (FIPS) code (FIPS 6-4) which uniquely identifies counties and county equivalents in the United States, certain U.S. possessions, and certain freely associated states. This is the 3-digit part of the 5-digit county FIPS code specifically standing for the county.
"geocoded_column", -- This includes a generic georeferenced point of Latitude and Longitude for each county and a generic point for the state of PA to help with creating visuals such as maps. If the statewide total for PA should be shown on the map, this centroid provides the means to show the statewide total at the SE part of PA actually in Maryland, so that the statewide total can be shown on on the map without adding to the total within another county.
"age_group", -- Indicates whether data represents total age population (All Ages) or specific Age Groups, including 0-14 years of age, 15-24 years of age, 25-34 years of age, 35-44 years of age, 45-54 years of age, 55-64 years of age or 65 and older (65+).
"time_measure", -- Time frame the rate is based on
"year", -- Calendar Year the data is based on
":@computed_region_rayf_jjgk",
":@computed_region_r6rf_p9et",
":@computed_region_d3gw_znnf",
":@computed_region_nmsq_hqvv",
"latitude", -- This includes a generic point of Latitude for each county and a generic point for the state of PA to help with creating visuals such as maps. If the statewide total for PA should be shown on the map, this latitude provides the means to show the statewide total at the SE part of PA actually in Maryland, so that the statewide total can be shown on on the map without adding to the total within another county.
"longitude", -- This includes a generic point of Longitude for each county and a generic point for the state of PA to help with creating visuals such as maps. If the statewide total for PA should be shown on the map, this latitude provides the means to show the statewide total at the SE part of PA actually in Maryland, so that the statewide total can be shown on on the map without adding to the total within another county.
":@computed_region_amqz_jbr4"
FROM
"pa-gov/buprenorphine-dispensation-data-quarter-3-2016-6js5-2mjf:latest"."buprenorphine_dispensation_data_quarter_3_2016"
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/buprenorphine-dispensation-data-quarter-3-2016-6js5-2mjf with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.pa.gov. When you querypa-gov/buprenorphine-dispensation-data-quarter-3-2016-6js5-2mjf: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.pa.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 \
"pa-gov/buprenorphine-dispensation-data-quarter-3-2016-6js5-2mjf" \
--handler-options '{
"domain": "data.pa.gov",
"tables": {
"buprenorphine_dispensation_data_quarter_3_2016": "6js5-2mjf"
}
}'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, pa-gov/buprenorphine-dispensation-data-quarter-3-2016-6js5-2mjf is just another Postgres schema.