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 foster_care table in this repository, by referencing it like:
"norfolk-gov/foster-care-8bq6-fd8n:latest"."foster_care"or in a full query, like:
SELECT
":id", -- Socrata column ID
"percent_of_state_total", -- Percentage of children in Virginia’s foster care whose custody belongs to Norfolk Department of Human Services.
"percent_asian", -- Percentage of children in foster care who are identified as Asian.
"multi_race", -- Includes all children in foster care who are identified as Multi-race.
"percent_race_unknown", -- Percentage of children in foster care whose race are unknown.
"age_under_1", -- Includes all children in foster care who are under the age of 1.
"percent_1_through_5", -- Percentage of children in foster care ages 1 through 5.
"age_10_through_12", -- Includes all children in foster care who are ages 10 through 12.
"percent_10_through_12", -- Percentage of children in foster care 10 through 12.
"age_16_through_18", -- Includes all children in foster care who are ages 16 through 18.
"percent_16_through_18", -- Percentage of children in foster care ages 16 through 18.
"goal_relative_placement", -- Includes all children in foster care whose goal is placement with relative.
"goal_adoption", -- Includes all children in foster care whose goal is adoption.
"percent_goal_adoption", -- Percentage of children in foster care with the goal of adoption.
"percent_goal_independent", -- Percentage of children in foster care with the goal of Independent Living.
"goal_another_planned_permanent", -- Includes all children in foster care whose goal is another planned permanent living arrangement.
"goal_to_be_determined", -- Includes all children in foster care whose goal is being determined.
"percent_no_goal_entered", -- Percentage of children in foster care where no goal has been entered into OASIS.
"average_time_in_care_atc", -- The average time in care for all children in foster care.
"atc_goal_return_home", -- The average time in care for all children in foster care with the goal of return home.
"atc_continued_foster_care", -- The average time in care for all children in foster care with the goal of continued foster care.
"atc_goal_to_be_determined", -- The average time in care for all children in foster care with the goal to be determined.
"atc_no_goal_entered", -- The average time in care for all children in foster care with no goal entered into OASIS.
"total_children_in_care", -- Includes all children in foster care in Norfolk within the month.
"percent_male", -- Percentage of children in foster care who are identified as male.
"american_indian_alaskan_native", -- Includes all children in foster care who are identified as American Indian Alaskan Native.
"hispanic", -- Includes all children in foster care who are identified as Hispanic.
"age_6_through_9", -- Includes all children in foster care who are ages 6 through 9.
"month_and_year", -- Month and year the report covers.
"male", -- Includes all children in foster care who are identified as male.
"female", -- Includes all children in foster care who are identified as female.
"percent_female", -- Percentage of children in foster care who are identified as female.
"sex_unknown", -- Includes all children in foster care whose sex is unknown.
"black", -- Includes all children in foster care who are identified as Black.
"percent_black", -- Percentage of children in foster care who are identified as Black.
"white", -- Includes all children in foster care who are identified as White.
"percent_white", -- Percentage of children in foster care who are identified as White.
"percent_hawaiian_pacific", -- Percentage of children in foster care who are identified as Hawaiian Pacific Islander.
"percent_multi_race", -- Percentage of children in foster care who are identified as Multi-race.
"percent_hispanic", -- Percentage of children in foster care who are identified as Hispanic.
"percent_under_1", -- Percentage of children in foster care who are under the age of 1.
"age_1_through_5", -- Includes all children in foster care who are ages 1 through 5.
"percent_6_through_9", -- Percentage of children in foster care ages 6 through 9.
"age_13_through_15", -- Includes all children in foster care who are ages 13 through 15.
"percent_13_through_15", -- Percentage of children in foster care ages 13 through 15.
"age_19_and_over", -- Includes all youth are receiving foster care services through Fostering Futures who are age 19 and over.
"percent_19_and_over", -- Percentage of all youth are receiving foster care services through Fostering Futures who are age 19 and over.
"goal_return_home", -- Includes all children in foster care whose goal is return home.
"percent_goal_return_home", -- Percentage of children in foster care with the goal of return home.
"percent_american_indian", -- Percentage of children in foster care who are identified as American Indian Alaskan Native.
"asian", -- Includes all children in foster care who are identified as Asian.
"percent_goal_relative", -- Percentage of children in foster care with the goal of relative placement.
"percent_goal_permanent_foster", -- Percentage of children in foster care with the goal of permanent foster care.
"goal_independent_living", -- Includes all children in foster care whose goal is Independent Living.
"percent_goal_another_planned", -- Percentage of children in foster care with the goal of another planned living arrangement.
"percent_goal_continued_foster", -- Percentage of children in foster care with the goal of continued foster care.
"percent_goal_to_be_determined", -- Percentage of children in foster care whose goal is being determined.
"no_goal_entered", -- Includes all children in foster care where no goal has been entered into OASIS.
"atc_goal_placement_with", -- The average time in care for all children in foster care with the goal of placement with relatives.
"atc_goal_adoption", -- The average time in care for all children in foster care with the goal of adoption.
"atc_goal_permanent_foster", -- The average time in care for all children in foster care with the goal of permanent in foster care.
"atc_goal_independent_living", -- The average time in care for all children in foster care with the goal of independent living.
"atc_goal_another_planned", -- The average time in care for all children in foster care with the goal of another planned permanent living arrangement.
"race_unknown", -- Includes all children in foster care whose race are unknown.
"date_of_birth_not_entered", -- Includes all children in foster care who do not have a birth date entered into OASIS.
"goal_continued_foster_care", -- Includes all children in foster care whose goal is continued foster care.
"percent_goal_guardianship", -- Percentage of children in foster care whose goal is guardianship.
"percent_sex_unknown", -- Percentage of children in foster care whose sex is unknown.
"atc_goal_guardianship", -- The average time in care for all children in foster care with the goal of guardianship.
"goal_permanent_foster_care", -- Includes all children in foster care whose goal is permanent foster care.
"hawaiian_pacific_islander", -- Includes all children in foster care who are identified as Hawaiian Pacific Islander.
"percent_date_of_birth_not", -- Percentage of all children in foster care who do not have a birth date entered into OASIS.
"goal_guardianship" -- Includes all children in foster care whose goal is guardianship.
FROM
"norfolk-gov/foster-care-8bq6-fd8n:latest"."foster_care"
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 norfolk-gov/foster-care-8bq6-fd8n with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.norfolk.gov. When you querynorfolk-gov/foster-care-8bq6-fd8n: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
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.norfolk.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 \
"norfolk-gov/foster-care-8bq6-fd8n" \
--handler-options '{
"domain": "data.norfolk.gov",
"tables": {
"foster_care": "8bq6-fd8n"
}
}'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, norfolk-gov/foster-care-8bq6-fd8n is just another Postgres schema.