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 participating_lenders_with_sonyma_state_of_new table in this repository, by referencing it like:
"ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza:latest"."participating_lenders_with_sonyma_state_of_new"or in a full query, like:
SELECT
":id", -- Socrata column ID
"lender_name", -- Name of SONYMA participating lender
"sonyma_region_9_contact", -- Region 9 consists of Nassau and Suffolk Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"principal_office_phone_number", -- Phone number
"city", -- City location of main office
"sonyma_region_3_contact", -- Region 3 consists of Cayuga, Cortland, Madison, Onondaga, and Oswego Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"sonyma_region_10_contact", -- Region 10 consists of Bronx, Kings, New York, Queens and Richmond Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"sonyma_region_4_contact", -- Region 4 consists of Allegany, Broome, Chemung, Chenango, Delaware, Otsego, Schuyler, Steuben, Tioga, and Tompkins Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"woman_owned", -- Yes notes if lender is a Women-Owned business. This field may contain blanks.
"minority_owned", -- Yes notes if lender is a Minority-Owned business. This field may contain blanks.
"sonyma_region_8_contact", -- Region 8 consists of Rockland and Westchester Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"sonyma_region_7_contact", -- Region 7 consists of Clinton, Essex, Franklin, Fulton, Hamilton, Herkimer, Jefferson, Lewis, Oneida, St. Lawrence, Warren, and Washington Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"sonyma_region_1_contact", -- Region 1 consists of Cattaraugus, Chautauqua, Erie and Niagara Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"state", -- State of main office
"zip", -- Zip Code of main office
"sonyma_region_5_contact", -- Region 5 consists of Columbia, Dutchess, Greene, Orange, Putnam, Sullivan, and Ulster Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"sonyma_region_6_contact", -- Region 6 consists of Albany, Montgomery, Rensselaer, Saratoga, Schenectady, and Schoharie Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"regulatory_authority", -- Notes the lender’s regulating body. FDIC is Federal Deposit Insurance Company.
"lenders_website_address", -- Website Address
"principal_office_address", -- Street address of main office
"sonyma_region_2_contact", -- Region 2 consists of Genesee, Livingston, Monroe, Ontario, Orleans, Seneca, Wayne, Wyoming, and Yates Counties. Potential homebuyers looking to purchase a home in any of these counties may call the listed telephone number to apply. If this column is blank, the lender does not offer SONYMA loans in this region.
"company", -- If the institution is a Mortgage Banker, notes whether lender is an independently run company or a subsidiary of a larger institution; otherwise this is left blank.
"institution_type" -- Type of institution; for mor information, see http://www.dfs.ny.gov/about/whowesupervise.htm
FROM
"ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza:latest"."participating_lenders_with_sonyma_state_of_new"
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 ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza 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 ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza: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 ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qezaCheckout 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 ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza:latestThis will download all the objects for the latest tag of ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza 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 ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza: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 ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza: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, ny-gov/participating-lenders-with-sonyma-state-of-new-h59s-qeza is just another Postgres schema.