brla-gov/cityparish-revenue-budget-4kxx-65v6
Icon for Socrata external plugin

Query the Data Delivery Network

Query the DDN

The 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 cityparish_revenue_budget table in this repository, by referencing it like:

"brla-gov/cityparish-revenue-budget-4kxx-65v6:latest"."cityparish_revenue_budget"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "segment4", -- The name of the division (within the department) under which the budget is authorized and recorded.
    "project", -- The name of the project under which the budget is authorized and recorded.
    "segment4code", -- The numerical value of the division (within the department) under which the budget is authorized and recorded.
    "segment2code", -- The numerical value of the department under which the budget is authorized and recorded.
    "segment6code", -- The numerical value of the subprogram (within the program) under which the budget is authorized and recorded.
    "uniqueid", -- Unique ID for this revenue record
    "fullaccount", -- The combination of account segments to identify funding under which the budget is authorized and recorded.
    "projectcode", -- The numerical value of the project under which the budget is authorized and recorded.
    "originalbudget", -- The numerical value of the original annual operating budget approved by the Metropolitan Council.
    "accountid", -- Unique ID for account number
    "accountdescription", -- Description of the revenue type.
    "segment5", -- The name of the program (within the department) under which the budget is authorized and recorded.
    "actual", -- The amount of revenues collected to date.
    "fundcode", -- The numerical value of the fund under which the budget is authorized and recorded.
    "fiscalyear", -- The year in which the budget was recorded.
    "accountstatus", -- Status of account, either Active or Inactive
    "revisedbudget", -- The numerical value of the revised annual operating budget that includes mid-year amendments approved by the Metropolitan Council.
    "segment3", -- The function/purpose of the fund under which the budget is authorized and recorded.
    "segment3code", -- The numerical value of the function/purpose of the fund under which the budget is authorized and recorded.
    "segment6", -- The name of the subprogram (within the program) under which the budget is authorized and recorded.
    "segment2", -- The name of the department under which the budget is authorized and recorded.
    "object", -- The name of the object used to track and classify types of  revenuesunder which the budget is authorized and recorded.
    "objectcode", -- The numerical value of the object used to track and classify types of revenues under which the budget is authorized and recorded.
    "fund", -- The name of the fund under which the budget is authorized and recorded.
    "fiscalmonth", -- The month in which the budget was recorded.
    "segment5code", -- The numerical value of the program (within the department) under which the budget is authorized and recorded.
    "charactercode", -- The numerical value of the group and subtotal used to track and classify types of  revenues under which the budget is authorized and recorded.
    "charactercodedescription" -- The name of the group and subtotal used to track and classify types of  revenues under which the budget is authorized and recorded.
FROM
    "brla-gov/cityparish-revenue-budget-4kxx-65v6:latest"."cityparish_revenue_budget"
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 brla-gov/cityparish-revenue-budget-4kxx-65v6 with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.brla.gov. When you querybrla-gov/cityparish-revenue-budget-4kxx-65v6: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

Install Splitgraph Locally
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 data.brla.gov, 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 \
  "brla-gov/cityparish-revenue-budget-4kxx-65v6" \
  --handler-options '{
    "domain": "data.brla.gov",
    "tables": {
        "cityparish_revenue_budget": "4kxx-65v6"
    }
}'

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, brla-gov/cityparish-revenue-budget-4kxx-65v6 is just another Postgres schema.