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 311_service_requests_for_2005 table in this repository, by referencing it like:
"cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h:latest"."311_service_requests_for_2005"or in a full query, like:
SELECT
":id", -- Socrata column ID
"city", -- City of the incident location provided by geovalidation.
"landmark", -- If the incident location is identified as a Landmark the name of the landmark will display here
"facility_type", -- If available, this field describes the type of city facility associated to the SR
"due_date",
"x_coordinate_state_plane_",
"y_coordinate_state_plane_",
"park_borough",
"school_region",
"school_address",
"school_state",
"school_zip",
"taxi_company_borough",
"bridge_highway_name",
"bridge_highway_direction",
"garage_lot_name",
"ferry_terminal_name",
"latitude",
"location_state",
"location_address",
"unique_key", -- Unique identifier of a Service Request (SR) in the open data set. This is NOT the Service Request (SR) # provided to the initiating customer. SR #s are not available in this data set.
"created_date", -- Date SR was created
"complaint_type", -- This is the fist level of a hierarchy identifying the topic of the incident or condition. Complaint Type may have a corresponding Descriptor (below) or may stand alone.
"descriptor", -- This is associated to the Complaint Type, and provides further detail on the incident or condition. Descriptor values are dependent on the Complaint Type, and are not always required in SR.
"location_type", -- Describes the type of location used in the address information
"closed_date", -- Date SR was closed by responding agency
"park_facility_name",
":@computed_region_f5dn_yrer",
":@computed_region_92fq_4b7q",
":@computed_region_sbqj_enih",
":@computed_region_efsh_h5xi",
":@computed_region_yeji_bk3q",
"location_zip",
"road_ramp",
"school_not_found",
"school_or_citywide_complaint",
"ferry_direction",
"taxi_pick_up_location",
"bridge_highway_segment",
"vehicle_type",
"agency", -- Acronym of responding City Government Agency
"agency_name", -- Full Agency name of responding City Government Agency
"street_name", -- Street name of incident address provided by the submitter
"cross_street_1", -- First Cross street based on the geo validated incident location
"longitude",
"school_city",
"school_phone_number",
"school_code",
"school_number",
"incident_zip", -- Incident location zip code, provided by geo validation.
"incident_address", -- House number of incident address provided by submitter.
"cross_street_2", -- Second Cross Street based on the geo validated incident location
"intersection_street_1", -- First intersecting street based on geo validated incident location
"intersection_street_2", -- Second intersecting street based on geo validated incident location
"address_type", -- Type of incident location information available.
"status",
"resolution_action_updated_date",
"community_board",
"borough",
"school_name",
"location_city",
"location"
FROM
"cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h:latest"."311_service_requests_for_2005"
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 cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h 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 cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h: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 cityofnewyork-us/311-service-requests-for-2005-sxmw-f24hCheckout 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 cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h:latestThis will download all the objects for the latest tag of cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h 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 cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h: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 cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h: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, cityofnewyork-us/311-service-requests-for-2005-sxmw-f24h is just another Postgres schema.