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 chicago_public_schools_high_school_progress_report table in this repository, by referencing it like:
"cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f:latest"."chicago_public_schools_high_school_progress_report"or in a full query, like:
SELECT
":id", -- Socrata column ID
"college_retention_2009_percent",
":@computed_region_6mkv_f3dw",
"freshman_on_track_to_graduate_2012_percent",
"latitude",
"college_eligibility_2011_percent",
"college_eligibility_2012_percent",
"y_coordinate",
"involved_families", -- Does the school partner with families and communities? For more information, visit https://cps.5-essentials.org/2012.
"supportive_environment", -- Is the school safe and supportive with high expectations? For more information, visit https://cps.5-essentials.org/2012.
"blue_ribbon_award", -- Did the school win a U.S. Department of Education Blue Ribbon? See http://www2.ed.gov/programs/nclbbrs/index.html.
"effective_leaders", -- Does leadership focus on results and school improvement? For more information, visit https://cps.5-essentials.org/2012.
"teacher_attendance_2012_percent", -- Average daily attendance of teachers -- the number of days in which teachers were present divided by the number of days they were scheduled to work.
"teacher_attendance_2011_percent", -- Average daily attendance of teachers -- the number of days in which teachers were present divided by the number of days they were scheduled to work.
"collaborative_teachers", -- Do teachers work well together and strive for excellence? For more information, visit https://cps.5-essentials.org/2012.
"location_address",
"years_on_probation", -- How many years has the school been on probation?
"student_performance_level",
"college_enrollment_2011_percent",
"average_score_plan_2012",
"overall_foundation", -- Overall status from the "My Voice, My School" survey completed by teachers and 6th-12th grade students. For more information, visit https://cps.5-essentials.org/2012.
"blue_ribbon_award_year", -- Year in which the school won a U.S. Department of Education Blue Ribbon.
"student_attendance_2012_percent", -- Average daily attendance of students -- the number of days in which students were present divided by the number of days in which students were scheduled to attend.
"average_days_of_suspension_2012", -- Average length of suspensions, in days, divided by the number of suspensions.
"college_enrollment_2012_percent",
"x_coordinate",
"average_days_of_suspension_2011", -- Average length of suspensions, in days, divided by the number of suspensions.
":@computed_region_rpca_8um6",
"one_year_dropout_rate_2012_percent",
"location_zip",
"location_city",
":@computed_region_awaf_s7ux",
"city",
"ambitious_instruction", -- Is instruction focused, challenging, and engaging? For more information, visit https://cps.5-essentials.org/2012.
"healthy_school_certified", -- Is the school certified by the USDA’s Healthier US School Challenge?
"one_year_dropout_rate_2011_percent",
"state",
"_5_year_cohort_graduation_rate_2012_percent",
"street_address",
"managed_by_network",
"geographic_network",
"school_track", -- Which schedule. See http://www.cps.edu/calendar/Pages/Calendar.aspx.
"overall_rating", -- The Overall Rating on the school progress report is based on the school’s rating under the 2012-2013 Performance, Remediation and Probation Policy. Level 1 is highest.
"on_probation", -- Is the school on probation?
":@computed_region_bdys_3d7i",
"college_retention_2010_percent",
"growth_overall_level", -- Student growth compared to similar schools nationally
"average_score_explore_2012",
"misconducts_resulting_in_suspensions_2011_percent", -- Number of misconducts resulting in suspension divided by the number of misconducts reported.
"over_time_plan_2011",
"_5_year_cohort_graduation_rate_2011_percent",
"location",
"misconducts_resulting_in_suspensions_2012_percent", -- Number of misconducts resulting in suspension divided by the number of misconducts reported.
"school_id",
"school_short_name",
"school_name",
"zip",
"student_attendance_2011_percent", -- Average daily attendance of students -- the number of days in which students were present divided by the number of days in which students were scheduled to attend.
"longitude",
"website",
"over_time_act_2012",
"growth_explore",
"average_score_act_2012",
"safety", -- Do students feel safe and does the school support positive behavior? For more information, visit https://cps.5-essentials.org/2012.
"growth_plan",
":@computed_region_43wa_7qmu",
":@computed_region_vrxf_vc4k",
"location_state",
"growth_act",
"freshman_on_track_to_graduate_2011_percent",
"growth_all_grades",
"over_time_explore_2010"
FROM
"cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f:latest"."chicago_public_schools_high_school_progress_report"
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 cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f 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 cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f: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 cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9fCheckout 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 cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f:latestThis will download all the objects for the latest tag of cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f 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 cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f: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 cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f: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, cityofchicago/chicago-public-schools-high-school-progress-report-qemx-3d9f is just another Postgres schema.