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 brec_park table in this repository, by referencing it like:
"brla-gov/brec-park-7j6g-4hxu:latest"."brec_park"or in a full query, like:
SELECT
":id", -- Socrata column ID
"classification", -- Classification of the facility
"stadium", -- Facility offers a Stadium (Yes or No)
"shuffleboard", -- Facility offers Shuffleboard (Yes or No)
"playground", -- Facility offers a Playground (Yes or No)
"dog_park", -- Facility offers a Dog Park (Yes or No)
"greenway_trailhead", -- Facility offers a Greenway Trailhead (Yes or No)
"soccer_field", -- Facility offers Soccer Field (Yes or No)
"full_address", -- Street address of the facility
"tennis_center", -- Facility offers a Tennis Center (Yes or No)
"bike_repair_station", -- Facility offers a Bike Repair Station (Yes or No)
"blueway_trailhead", -- Facility offers a Blueway Trailhead (Yes or No)
"canoe_kayak_launch", -- Facility offers a Canoe Kayak Launch (Yes or No)
"cricket_pitch", -- Facility offers a Cricket Pitch (Yes or No)
"skate_park", -- Facility offers a Skate Park (Yes or No)
"golf_course_9_hole", -- Facility offers a 9-Hole Golf Course (Yes or No)
"ball_multi_purpose_field", -- Facility offers a Multi-Purpose Ball Field (Yes or No)
"tennis_courts", -- Facility offers a Tennis Court (Yes or No)
"bg_id", -- BREC ID for the facility
"city", -- City
"parkid", -- Park name abbreviation
"swimming_pool", -- Facility offers a Swimming Pool (Yes or No)
"disc_golf", -- Facility offers Disc Golf (Yes or No)
"bmx", -- Facility offers Bicycle Motocross (Yes or No)
"walking_loop_outdoor", -- Facility offers an Outdoor Walking Loop (Yes or No)
"acreage", -- Number of acres the facility occupies
"nature_trails", -- Facility offers Nature Trails (Yes or No)
"fitness_centers", -- Facility offers a Fitness Center (Yes or No)
"basketball_outdoor", -- Facility offers Outdoor Basketball (Yes or No)
"bird_watching_wildlife_viewing", -- Facility offers Bird Watching Wildlife Viewing (Yes or No)
"zip", -- ZIP Code
"facility_name", -- BREC facility name
"walking_track_indoor", -- Facility offers an Indoor Walking Track (Yes or No)
"velodrome", -- Facility offers a Velodrome (Yes or No)
"the_geom", -- Shape geometry of the BREC Park
"splash_pad", -- Facility offers a Splash Pad (Yes or No)
"sand_volleyball", -- Facility offers Sand Volleyball (Yes or No)
"rv_park", -- Facility offers an RV Park (Yes or No)
"rugby_field", -- Facility offers a Rugby Field (Yes or No)
"recreation_center", -- Facility offers a Recreation Center (Yes or No)
"primitive_trails", -- Facility offers Primitive Trails (Yes or No)
"pavilion", -- Facility offers a Pavilion (Yes or No)
"outdoor_fitness_station", -- Facility offers an Outdoor Fitness Station (Yes or No)
"mountain_biking", -- Facility offers Mountain Biking (Yes or No)
"golf_course_18_hole", -- Facility offers an 18-Hole Golf Course (Yes or No)
"garden_arboretum", -- Facility offers a Garden Arboretum (Yes or No)
"fishing_access", -- Facility offers Fishing Access (Yes or No)
"equestrian", -- Facility offers Equestrian (Yes or No)
"croquet_court", -- Facility offers a Croquet Court (Yes or No)
"basketball_indoor", -- Facility offers Indoor Basketball (Yes or No)
"archery_range", -- Facility offers an Archery Range (Yes or No)
"airnasium", -- Facility offers an Airnasium (Yes or No)
"airgun_range" -- Facility offers an Airgun Range (Yes or No)
FROM
"brla-gov/brec-park-7j6g-4hxu:latest"."brec_park"
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 brla-gov/brec-park-7j6g-4hxu with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.brla.gov. When you querybrla-gov/brec-park-7j6g-4hxu: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.brla.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 \
"brla-gov/brec-park-7j6g-4hxu" \
--handler-options '{
"domain": "data.brla.gov",
"tables": {
"brec_park": "7j6g-4hxu"
}
}'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, brla-gov/brec-park-7j6g-4hxu is just another Postgres schema.