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 nors table in this repository, by referencing it like:
"cdc-gov/nors-5xkq-dg7x:latest"."nors"or in a full query, like:
SELECT
":id", -- Socrata column ID
"animal_type", -- For animal contact outbreaks only, the type of animal involved. Multiple animal types are separated by a semicolon.
"water_type", -- For waterborne outbreaks only, a description of the venue (for treated and untreated recreational water), water system (for drinking water) or device/structure (for other/unknown; e.g., steam cleaner, cooling tower, ornamental fountain, etc.) that was the vehicle for waterborne exposure to microbial pathogens, chemicals, or toxins.
"ifsac_category", -- For foodborne outbreaks only, the IFSAC food category of the contaminated ingredient. If contaminated ingredients fall into multiple IFSAC categories, "Multiple" will be listed.
"food_contaminated_ingredient", -- For foodborne outbreaks only, indicates the contaminated ingredient. Multiple contaminated ingredients are separated by a semicolon.
"food_vehicle", -- For foodborne outbreaks only, the implicated food. Multiple implicated foods are separated by a semicolon.
"info_on_deaths", -- Total number of primary cases for whom information on survival is available.
"deaths", -- Number of primary cases who died.
"info_on_hospitalizations", -- Total number of primary cases for whom information on hospitalization is available.
"illnesses", -- Estimated total number of primary cases, including lab-confirmed and probable, based on the outbreak-specific definition.
"setting", -- Setting(s) where exposure occurred. For foodborne outbreaks, this is the location where food was eaten.
"etiology_status", -- Indicates whether or not the identified etiology is laboratory 'Confirmed' or 'Suspected'. Multiple reported etiologies are separated by a semicolon.
"serotype_or_genotype", -- Serotype or genotype of identified etiology. Multiple reported etiologies are separated by a semicolon.
"etiology", -- Genus and species of identified etiology. Multiple reported etiologies are separated by a semicolon.
"primary_mode", -- Primary mode of transmission.
"state", -- The state where the exposure occurred. For a single state of exposure, the state will be listed. For multiple states of exposure, "Multistate" will be listed.
"month", -- Month of earliest date of reported illness onset
"year", -- Year of earliest date of reported illness onset
"hospitalizations", -- Number of primary cases who were hospitalized.
"water_exposure" -- For waterborne outbreaks only, the implicated type of water exposure.
FROM
"cdc-gov/nors-5xkq-dg7x:latest"."nors"
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/nors-5xkq-dg7x 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/nors-5xkq-dg7x: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/nors-5xkq-dg7xCheckout 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/nors-5xkq-dg7x:latestThis will download all the objects for the latest tag of cdc-gov/nors-5xkq-dg7x 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/nors-5xkq-dg7x: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/nors-5xkq-dg7x: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/nors-5xkq-dg7x is just another Postgres schema.