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 report_card_discipline_for_201415_to_202122_school table in this repository, by referencing it like:
"wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker:latest"."report_card_discipline_for_201415_to_202122_school"or in a full query, like:
SELECT
":id", -- Socrata column ID
"disciplinedatnotes", -- This describes if the data has had a Disclosure Avoidance Technique (DAT) applied in accordance with our DAT guidelines. For more information about our DAT methods please see: https://www.k12.wa.us/data-reporting/protecting-student-privacy
"currentschooltype", -- School type code, please see https://eds.ospi.k12.wa.us/DirectoryEDS.aspx for more on school type codes
"schoolcode", -- Unique school code. When OrganizationLevel = "State" or "District", this field will be NULL
"schoolname", -- School name. When OrganizationLevel = "State" or "District", this field will be NULL
"schoolorganizationid", -- Unique school identification number. When OrganizationLevel = "State" or "District", this field will be NULL
"student_group", -- This field describes the students by parsing out the Specific StudentGroupType into their subgroups: such as Male, Female, and Gender X, or Non Low-income and Low Income student groups.
"disciplinenumerator", -- Unique count of students enrolled at any point during the school year with 1 or more exclusions.
"disciplinerate", -- (Discipline Numerator)/(Discipline Denominator)
"excluded1dayorless", -- Unique count of students excluded for 1 day or less during the regular school year
"rateexcluded1dayorless", -- Percent of students excluded for 1 day or less during the regular school year
"excluded2to3days", -- Unique count of students excluded for 2-3 days during the regular school year
"rateexcluded2to3days", -- Percent of students excluded for 2-3 days during the regular school year
"excluded4to5days", -- Unique count of students excluded for 4-5 days or less during the regular school year
"rateexcluded4to5days", -- Percent of students excluded for 4-5 days or less during the regular school year
"excluded6to10days", -- Unique count of students excluded for 6-10 days during the regular school year
"rateexcluded6to10days", -- Percent of students excluded for 6-10 days during the regular school year
"excluded10daysormore", -- Unique count of students excluded for 10 or more days during the regular school year
"rateexcluded10daysormore", -- Percent of students excluded for 10 or more days during the regular school year
"dateextracted", -- Date the file was last updated
"districtname", -- District name. When OrganizationLevel = "State", this field will be NULL
"districtcode", -- Unique district code. When OrganizationLevel = "State", this field will be NULL
"esdorganizationid", -- Unique ESD Identification number. When OrganizationLevel = "State", this field will be NULL
"esdname", -- Name the the Educational Service District serving the district or school. When OrganizationLevel = "State", this field will be NULL
"county", -- County Name in which the school or district resides. When OrganizationLevel = "State", this field will be reported as "Multiple"
"schoolyear", -- 6 character year displayed as YYYY-YY (e.g., 2019-20)
"organizationlevel", -- The level at which the data is aggregated. Allowable values = School, District, County, and State.
"gradelevel", -- Designates grade of students, "All Grades" identifies rows in which all students were counted (regardless of Grade)
"districtorganizationid", -- Unique district identification number. When OrganizationLevel = "State", this field will be NULL
"disciplinedenominator" -- Unique count of students enrolled at any point during the school year (between Sep. 1st and Jun. 1st)
FROM
"wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker:latest"."report_card_discipline_for_201415_to_202122_school"
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/report-card-discipline-for-201415-to-202122-school-fwbr-3ker 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 wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker: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 wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3kerCheckout 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 wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker:latestThis will download all the objects for the latest tag of wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker 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 wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker: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 wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker: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, wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker is just another Postgres schema.