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 behavioral_risk_factor_data_tobacco_use_2011_to table in this repository, by referencing it like:
"cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5:latest"."behavioral_risk_factor_data_tobacco_use_2011_to"or in a full query, like:
SELECT
":id", -- Socrata column ID
"displayorder", -- Display order; used in application
"submeasureid", -- Submeasure identifier code - can be used for filtering; used in application
"stratificationid4", -- Education identifier code - can be used for filtering; used in application
"stratificationid3", -- Race identifier code - can be used for filtering; used in application
"stratificationid2", -- Age identifier code - can be used for filtering; used in application
"stratificationid1", -- Gender identifier code - can be used for filtering; used in application
"geolocation_zip",
"geolocation_state",
"measureid", -- Measure identifier - can be used for filtering
"geolocation_city",
"topicid", -- Topic identifier code - can be used for filtering; used in application
"geolocation", -- Geolocation codes for mapping purposes
"education", -- Education level of respondents
"age", -- Age of respondents
"gender", -- Gender of respondents
"high_confidence_limit", -- Confidence interval upper limit
"low_confidence_limit", -- Confidence interval lower limit
"data_value_std_err", -- Standard error for the data value
"data_value_footnote_symbol", -- Where applicable, this text is associated with the footnote symbol
"data_value", -- Value of the data
"data_value_type", -- Type of data (yes/no, percentage, dollar, etc)
"data_value_unit", -- Indicator of the type of data value ($, %, etc)
"response", -- Response categories
"measuredesc", -- Measure description
"topictype", -- Type of topic
"locationdesc", -- Location description
"locationabbr", -- Location abbreviation
"year", -- Year
":@computed_region_hjsp_umg2", -- This column was automatically created in order to record in what polygon from the dataset 'States' (hjsp-umg2) the point in column 'geolocation' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens.
"geolocation_address",
"topictypeid", -- Topic type identifier code - can be used for filtering; used in application
"race", -- Race of respondents
"sample_size", -- Sample size
"data_value_footnote", -- Where applicable, this text is associated with the footnote text
"datasource", -- Data source
"topicdesc" -- Topic description
FROM
"cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5:latest"."behavioral_risk_factor_data_tobacco_use_2011_to"
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 cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5 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 cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5: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 cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5Checkout 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 cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5:latestThis will download all the objects for the latest tag of cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5 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 cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5: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 cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5: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, cdc-gov/behavioral-risk-factor-data-tobacco-use-2011-to-wsas-xwh5 is just another Postgres schema.