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 iowa_credit_union_assets table in this repository, by referencing it like:
"mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by:latest"."iowa_credit_union_assets"or in a full query, like:
SELECT
":id", -- Socrata column ID
"otha", -- All other assets not previously reported. Examples of other asset accounts include accrued income, prepaid expenses, and accounts receivable.
"ncusif", -- The National Credit Union Share Insurance Fund deposit required to maintain federal share insurance.
"lbldg", -- The book value of all property owned by the credit union.
"foreclose", -- Fixed assets the credit union has acquired due to foreclosures.
"alll", -- a credit balance account that is used to absorb possible loan losses.
"tloan", -- The balance of all loans financed by the credit union.
"orel", -- Total balance of real estate loans to members that are not in 1st position.
"fmort", -- Total balance of mortgage loans in 1st lien position. This balance includes both business and residential mortgages.
"uvl", -- Total balance of used vehicle loans to members.
"nvl", -- Total balance of new vehicle loans to members.
"nfgstl", -- The balance of non-federally guaranteed student loans to members.
"unsecured", -- Balance of all other member unsecured loan debt.
"ucc", -- The balance of unsecured member credit card debt.
"othinv", -- The amount of other investments not included in the preceding investment categories.
"pic", -- Total of Paid-in Capital at Corporate Credit Unions
"mccorp", -- Membership capital deposited into a Corporate Credit Union
"cu", -- The amount of loans to or investments in another credit union other than a Corporate Credit Union.
"bank", -- The collective balance of all certificates of deposit held with a bank or savings and loan.
"htm", -- These are securities that the credit unions intends to keep until maturity. These investments are recorded at book value.
"afs", -- Investments subject to ASC 320, formerly SFAS 115, which the credit union has classified as available for sale. These investments must be recorded at current fair value.
"ce", -- Short-term, highly liquid investments. Cash equivalents include investments with an original maturity of 3 months or less, are readily convertible to cash or are used in the credit union's cash management activities.
"cod", -- Cash deposits with and deposits in transit to other financial institutions.
"coh", -- Cash on hand includes vault cash, ATM cash and any coin and currency held by the credit union.
"cycle_date",
"cu_name",
"report_id", -- Unique identifier for the report based on the NCUA insurance identification number and report date.
"otherloan", -- The balance of all other loans to members.
"lhs", -- Outstanding loan balances that will be sold on the secondary market.
"occuinv", -- Other investments held with a corporate credit union.
"cu_number", -- Number issued by the NCUA for share insurance
"totala", -- Total credit union assets
"ts", -- Investments that are bought and held principally for the purpose of selling the in near term.
"lease", -- The amount of outstanding direct financing leases to members
"tinv", -- Sum of all investment accounts
"fixeda" -- All other fixed assets owned by the credit union.
FROM
"mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by:latest"."iowa_credit_union_assets"
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 mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by 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 mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by: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 mydata-iowa-gov/iowa-credit-union-assets-vg9d-74byCheckout 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 mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by:latestThis will download all the objects for the latest tag of mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by 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 mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by: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 mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by: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, mydata-iowa-gov/iowa-credit-union-assets-vg9d-74by is just another Postgres schema.