wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

The 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
    "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. 
    "gradelevel", -- Designates grade of students, "All Grades" identifies rows in which all students were counted (regardless of Grade)
    "excluded1dayorless", -- Unique count of students excluded for 1 day or less during the regular school year
    "disciplinenumerator", -- Unique count of students enrolled at any point during the school year with 1 or more exclusions.
    "esdorganizationid", -- Unique ESD Identification number. When OrganizationLevel = "State", this field  will be NULL
    "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
    "rateexcluded1dayorless", -- Percent of students excluded for 1 day or less during the regular school year
    "disciplinerate", -- (Discipline Numerator)/(Discipline Denominator)
    "rateexcluded10daysormore", -- Percent of students excluded for 10 or more days during the regular school year
    "organizationlevel", -- The level at which the data is aggregated.  Allowable values = School, District, County, and State.
    "dateextracted", -- Date the file was last updated
    "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
    "excluded10daysormore", -- Unique count of students excluded for 10 or more days during the regular school year
    "disciplinedenominator", -- Unique count of students enrolled at any point during the school year (between Sep. 1st and Jun. 1st)
    "currentschooltype", -- School type code, please see https://eds.ospi.k12.wa.us/DirectoryEDS.aspx for more on school type codes
    "districtcode", -- Unique district code. When OrganizationLevel = "State", this field  will be NULL
    "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
    "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)
    "esdname", -- Name the the Educational Service District serving the district or school. When OrganizationLevel = "State", this field will be NULL
    "rateexcluded2to3days", -- Percent of students excluded for 2-3 days during the regular school year
    "districtname", -- District name. When OrganizationLevel = "State", this field  will be NULL
    "schoolcode", -- Unique school code. When OrganizationLevel = "State" or "District", this field  will be NULL
    "excluded2to3days", -- Unique count of students excluded for 2-3 days during the regular school year
    "districtorganizationid", -- Unique district identification number. When OrganizationLevel = "State", 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
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.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.wa.gov. When you querywa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker: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

Install Splitgraph Locally
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.wa.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 \
  "wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker" \
  --handler-options '{
    "domain": "data.wa.gov",
    "tables": {
        "report_card_discipline_for_201415_to_202122_school": "fwbr-3ker"
    }
}'

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, wa-gov/report-card-discipline-for-201415-to-202122-school-fwbr-3ker is just another Postgres schema.