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 lea_academic_and_student_wellbeing_plans table in this repository, by referencing it like:
"wa-gov/lea-academic-and-student-wellbeing-plans-s8nh-j5f4:latest"."lea_academic_and_student_wellbeing_plans"or in a full query, like:
SELECT
":id", -- Socrata column ID
"strategiesformentoring", -- Comma delimited list of strategies/Interventions the LEA reports they have implemented and can provide support and/or mentoring to other LEAs in implementing.
"narrative", -- LEA response to the prompt: "Describe how your LEA will consistently apply the selected equity analysis and diagnostic assessments to evaluate and monitor student progress and effectiveness of strategies/interventions implemented to address gaps in student learning and well-being."
"postedlink", -- Date LEA plan was publicly posted on the LEA website. Please note, not all URLs are direct links
"posteddate", -- Date LEA plan was publicly posted on the LEA website.
"academicongoing", -- Comma delimited list of Academic diagnostic assessments used two or more times in the school year
"equityanalysistoolname", -- Name of LEA's selected or created equity analysis tool
"schoolboardapprovaldate", -- Date plan was approved by the local school board or governing body
"schoolboardapproval", -- Yes, indicates plan was approved by the LEA's local governing body
"gradesserved", -- Comma delimited list of grades served by the LEA
"equityanalysistoollink", -- URL link to the publicly posted equity analysis tool. Please note, not all URLs are direct links
"plancontactemail", -- LEA contact email address
"submissiondate", -- Date plan was submitted to OSPI
"equityanalysistoolattestation", -- Yes, indicates the LEA attests that an equity analysis tool was used in the creation of the plan
"esdname", -- Name of Educational Service District (ESD). When LEA is not affiliated with an ESD or when LEAName provided could not be matched to OSPI directory information, this field will be null.
"strategicsupports", -- Comma delimited list of strategic supports provided to the specified grade level and student group
"studentgroup", -- Student Group
"wellbeingfrequencynotreported", -- Comma delimited list of Well-being diagnostic assessments for which the frequency of use was not mappable.
"wellbeingonetime", -- Comma delimited list of Well-being diagnostic assessments used one time per school year
"academicfrequencynotreported", -- Comma delimited list of Academic diagnostic assessments for which the frequency of use was not mappable.
"academiconetime", -- Comma delimited list of Academic diagnostic assessments used one-time per school year
"grade", -- Grade level. Due to survey tool limitations, grades affiliated with write-in responses for diagnostics will equal "Grade Not Reported"
"universalsupports", -- Comma delimited list of strategies the LEA reported as universal supports (provided to all students or across an entire grade level of the LEA)
"engagingvoicesother", -- Comma delimited list of strategies the LEA reported that did not link to student/family/community voice
"engagingstudentvoices", -- Comma delimited list of strategies the LEA reports using to engage student voice in the creation of this plan
"strategiesforsupport", -- Comma delimited list of strategies/Interventions the LEA reports they would like to implement and need additional support or mentoring to implement
"wellbeingongoing", -- Comma delimited list of Well-being diagnostic assessments used two or more times during the school year.
"engagingcommunityvoices", -- Comma delimited list of strategies the LEA using to engage community voice in the creation of this plan
"leacode", -- Unique DistrictCode. When the LEAName provided could not be matched to OSPI directory information, this field will be null.
"esdorganizationid", -- Unique ESDOrganizationId. When the LEAName provided could not be matched to OSPI directory information, this field will be null.
"plancontactname", -- LEA contact name
"engagingfamilyvoices", -- Comma delimited list of strategies the LEA reports using to engage family voice in the creation of this plan
"districtname", -- Name of Local Education Agency (LEA)
"leaorganizationid" -- Unique DistrictOrganizationId. When the LEA name provided could not be matched to OSPI directory information, this field will be null.
FROM
"wa-gov/lea-academic-and-student-wellbeing-plans-s8nh-j5f4:latest"."lea_academic_and_student_wellbeing_plans"
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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4 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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4: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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4Checkout 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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4:latestThis will download all the objects for the latest tag of wa-gov/lea-academic-and-student-wellbeing-plans-s8nh-j5f4 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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4: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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4: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/lea-academic-and-student-wellbeing-plans-s8nh-j5f4 is just another Postgres schema.