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 public_assistance_case_closings_by_reason_for table in this repository, by referencing it like:
"ny-gov/public-assistance-case-closings-by-reason-for-4x9s-7y8g:latest"."public_assistance_case_closings_by_reason_for"or in a full query, like:
SELECT
":id", -- Socrata column ID
"ta_comp_employ", -- Total Public Assistance case closings due to compliance issues related to employment; these include failure to participate as required in Public Assistance work participation requirements, such as failure to cooperate with establishing employability, failure to attend work program assignments and voluntarily leaving or failing to accept employment without good cause. Sum of Family Assistance and Safety Net Assistance case closings.
"ta_client_req", -- Total Public Assistance case closings at the request of the client. Sum of Family Assistance and Safety Net Assistance case closings.
"sna_residence", -- Safety Net Assistance case closings due to residence issues; these include cases not residing in the jurisdiction of application or where the client cannot be located.
"district_code", -- Contains a code ranging from 01 to 57 and 66, designating each of the State’s Local Social Services Districts, which are New York City and the remaining 57 counties. For the non-New York City counties, the code refers to the alphabetical order of the district name (e.g., Albany=01, Yates = 57). For New York City, the code is 66.
"month_code", -- Number corresponding to month. January = 1, December = 12, etc.
"fa_other", -- Family Assistance case closings due to issues not included in the previous categories.
"year", -- Year data pertains to
"fa_comp_other", -- Family Assistance case closings due to compliance issues other than employment; these include failure to comply with rules other than those related to employment, such as failure to show for eligibility interviews, provide required documentation to verify eligibility or comply with household composition requirements.
"month", -- Month data pertains to. Closings are reported on a monthly basis. Day is always the first day of the reference month. The first available month is January 2006.
"ta_finance", -- Total Public Assistance case closings due to financial issues; these include increased earned or unearned income, exceeding resource limits, or other household circumstance changes that make the case financially ineligible. Sum of Family Assistance and Safety Net Assistance case closings.
"district", -- Text name of each social services district.
"sna_other", -- Safety Net Assistance case closings due to issues not included in the previous categories.
"sna_comp_other", -- Safety Net Assistance case closings due to compliance issues other than employment; these include failure to comply with rules other than those related to employment, such as failure to show for eligibility interviews, provide required documentation to verify eligibility or comply with household composition requirements.
"sna_comp_employ", -- Safety Net Assistance case closings due to compliance issues related to employment; these include failure to participate as required in Public Assistance work participation requirements, such as failure to cooperate with establishing employability, failure to attend work program assignments and voluntarily leaving or failing to accept employment without good cause.
"sna_finance", -- Safety Net Assistance case closings due to financial issues; these include increased earned or unearned income, exceeding resource limits, or other household circumstance changes that make the case financially ineligible.
"sna_client_req", -- Safety Net Assistance case closings at the request of the client.
"fa_comp_employ", -- Family Assistance case closings due to compliance issues related to employment; these include failure to participate as required in Public Assistance work participation requirements, such as failure to cooperate with establishing employability, failure to attend work program assignments and voluntarily leaving or failing to accept employment without good cause.
"fa_residence", -- Family Assistance case closings due to residence issues; these include cases not residing in the jurisdiction of application or where the client cannot be located.
"ta_comp_other", -- Total Public Assistance case closings due to compliance issues other than employment; these include failure to comply with rules other than those related to employment, such as failure to show for eligibility interviews, provide required documentation to verify eligibility or comply with household composition requirements. Sum of Family Assistance and Safety Net Assistance case closings.
"fa_finance", -- Family Assistance case closings due to financial issues; these include increased earned or unearned income, exceeding resource limits, or other household circumstance changes that make the case financially ineligible.
"fa_client_req", -- Family Assistance case closings at the request of the client.
"ta_other", -- Total Public Assistance case closings due to issues not included in the previous categories. Sum of Family Assistance and Safety Net Assistance case closings.
"ta_residence" -- Total Public Assistance case closings due to residence issues; these include cases not residing in the jurisdiction of application or where the client cannot be located. Sum of Family Assistance and Safety Net Assistance case closings.
FROM
"ny-gov/public-assistance-case-closings-by-reason-for-4x9s-7y8g:latest"."public_assistance_case_closings_by_reason_for"
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/public-assistance-case-closings-by-reason-for-4x9s-7y8g 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/public-assistance-case-closings-by-reason-for-4x9s-7y8g: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/public-assistance-case-closings-by-reason-for-4x9s-7y8gCheckout 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/public-assistance-case-closings-by-reason-for-4x9s-7y8g:latestThis will download all the objects for the latest tag of ny-gov/public-assistance-case-closings-by-reason-for-4x9s-7y8g 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/public-assistance-case-closings-by-reason-for-4x9s-7y8g: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/public-assistance-case-closings-by-reason-for-4x9s-7y8g: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/public-assistance-case-closings-by-reason-for-4x9s-7y8g is just another Postgres schema.