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 afghanistan_reconstruction_trust_fund_artf_project table in this repository, by referencing it like:
"finances-worldbank/afghanistan-reconstruction-trust-fund-artf-project-79y4-tfzf:latest"."afghanistan_reconstruction_trust_fund_artf_project"or in a full query, like:
SELECT
":id", -- Socrata column ID
"application_deadline_year_sy", -- Solar year within which the Application Deadline Date falls.
"effective_year_sy", -- Solar year within which the Effective Date falls.
"task_team_leader", -- Task Team Leader for project.
"fund_allocation_year_cy", -- Calendar year within which the Posting Date falls.
"project_name", -- Short descriptive project name.
"project_id", -- A Bank project is referenced by a project ID (Pxxxxxxx). More than one loan, credit, or grant may be associated with one Project ID. Projects with no project ID represent Bank-executed work.
"trust_fund_grant_number", -- Trust Fund grant ID. Projects are identified by this ID.
"end_of_period_date", -- As Of Date represents the date as of which balances are shown in the report.
"fund", -- Fund/Program type.
"effective_year_cy", -- Calendar year within which the Effective Date falls.
"trustee_fund_name", -- Refers to the Trustee Fund name used in the World Bank system to identify a Trustee Account.
"project_status", -- Project status. Active, or closed. Note: Closed projects may still receive applications through Application Deadline Date.
"application_deadline_year_fy", -- Fiscal year within which the Application Deadline Date falls. The fiscal year begins on July 1st of the previous year and runs through June 30th of the designated year.
"effective_date", -- The date on which a legal agreement becomes effective, or is expected to become effective.
"closing_year_cy", -- Calendar year within which the Closing Date falls.
"fund_allocation_date", -- Allocation or Disbursement posting date. An amount (that is not $0.00) in the Allocation Amount or Disbursement column corresponds to the date in Transaction Posting Date column.
"fund_allocation_year_sy", -- Solar year within which the Posting Date falls.
"application_deadline_date", -- The date specified in the legal agreement (or extension) after which the Bank will no longer process disbursement request applications from the Borrower.
"closing_year_fy", -- Fiscal year within which the Closing Date falls. The fiscal year begins on July 1st of the previous year and runs through June 30th of the designated year.
"closing_year_sy", -- Solar year within which the Closing Date falls.
"closing_date_most_recent", -- The date specified in the legal agreement (or extension) after which the Bank may, by notice to the borrower, terminate the right to make withdrawals from the loan account.
"effective_year_fy", -- Fiscal year within which the Effective Date falls. The fiscal year begins on July 1st of the previous year and runs through June 30th of the designated year.
"trust_fund_number", -- Refers to Trustee Account. The Trustee Account is the account at the highest level in the Trust Fund hierarchy into which Contributions or other funds are received. Every Trust fund hierarchy has one Trustee Account.
"application_deadline_year_cy", -- Calendar year within which the Application Deadline Date falls.
"window", -- ARTF has three different funding moves: "Investment window" i.e Infrastructure, urban development, HRD etc ; "Recurrent Cost" i.e support operational cost of the grant operation agreement; and "Monitoring Agent fee".
"fund_allocation_year_fy", -- Fiscal year within which the Posting Date falls. The fiscal year begins on July 1st of the previous year and runs through June 30th of the designated year.
"sector", -- Corresponding Sector/Theme.
"disbursed_amount_in_usd", -- Amount disbursed from project to payee, per Grant disbursement arrangements. Negative amounts refer to cancellations or refunds.
"allocation_amount_in_usd" -- Amount allocated to project from FUND/Trust Fund Program to Trust Fund Grant. Negative amounts refer to cancelations or refunds.
FROM
"finances-worldbank/afghanistan-reconstruction-trust-fund-artf-project-79y4-tfzf:latest"."afghanistan_reconstruction_trust_fund_artf_project"
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 finances-worldbank/afghanistan-reconstruction-trust-fund-artf-project-79y4-tfzf with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at finances.worldbank.org. When you queryfinances-worldbank/afghanistan-reconstruction-trust-fund-artf-project-79y4-tfzf: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 finances.worldbank.org, 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 \
"finances-worldbank/afghanistan-reconstruction-trust-fund-artf-project-79y4-tfzf" \
--handler-options '{
"domain": "finances.worldbank.org",
"tables": {
"afghanistan_reconstruction_trust_fund_artf_project": "79y4-tfzf"
}
}'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, finances-worldbank/afghanistan-reconstruction-trust-fund-artf-project-79y4-tfzf is just another Postgres schema.