austintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n

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 procotol. 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 campaign_finance_report_detail_dataset table in this repository, by referencing it like:

"austintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n:latest"."campaign_finance_report_detail_dataset"

or in a full query, like:

SELECT 
    ":id", -- Socrata column ID
    "filer_address_2", -- The filer's street or mailing address.
    "unitemized_cred_card_total", -- The total of all unitemized credit card expenditures made by the filer during the reporting period 
    "date_filed", -- Date the structured data file was received by the Office of the City Clerk
    "unitemized_pledge_total", -- The total of all unitemized pledges received by the filer during the reporting period 
    "unitemized_expend_total", -- The total of all unitemized expenditures made by the filer during the reporting period 
    "treasurer_name", -- Name of the filer's campaign treasurer as listed on the report filed with the Office of the City Clerk.
    "unitemized_unpaid_total", -- The total of all unitemized unpaid obligations incurred by the filer during the reporting period 
    "treasurer_state", -- State of the filer’s campaign treasurer.
    "unitemized_loan_total", -- The total of all unitemized loans maintained by the filer during the reporting period 
    "report_type2", -- Secondary report type as listed on the form submitted, if applicable.
    "link_to_report", -- A link to view a PDF version of the report filed with the Office of the City Clerk.
    "form_type", -- The type of form filed.
    "filer_city", -- The filer’s city.
    "period_to", -- The date on which the reporting period for this report ends, if applicable.  For  the ATX 1, this field corresponds to the report date listed on the form.
    "election_type", -- The type of the election for which this report is filed, if applicable
    "unitemized_inkind_total", -- The total of all unitemized in-kind contributions received by the filer during the reporting period 
    "filer_name", -- Name of individual, committee, or entity filing the report. This name is a standardized format used by the Office of the City Clerk to ensure all of a filer's reports are accessible under a single name
    "report_type", -- The primary report type as listed on the form.
    "date_due", -- Due date of the report, if applicable.
    "office_held", -- For officeholders, the office currently held.
    "outstand_loan", -- Outstanding principal of all loans maintained as of the last day of the reporting period 
    "expend_total", -- The total of all expenditures made by the filer during the reporting period (itemized and unitemized) 
    "treasurer_phone", -- The area code, phone number and (if applicable) extension of the filer’s campaign treasurer
    "office_sought", -- For candidates in an upcoming election, the office being sought. For unsuccessful candidates in a recently held election, the office sought during the election preceding the deadline for this report.
    "election_date", -- The date of the election for which this report is filed, if applicable
    "period_from", -- The date on which the reporting period for this report starts. 
    "name_as_reported", -- Name of the filer, committee, or entity as listed on the report filed with the Office of the City Clerk.
    "treasurer_city", -- City of the filer’s campaign treasurer.
    "treasurer_address_2", -- Address of the filer's campaign treasurer.
    "report_id", -- Unique identifier for the specific report - can be used to link individual transactions to a specific report.
    "contrib_total", -- The total of all contributions received by the filer during the reporting period (itemized and unitemized) 
    "unitemized_contrib_total", -- The total of all unitemized contributions received by the filer during the reporting period 
    "filer_phone", -- The filer’s area code, phone number, and (if applicable) extension.
    "contrib_balance", -- The total of all political contributions, including interest and additional income, as of the last day of the reporting period 
    "treasurer_zip_code" -- Zip code of the filer’s campaign treasurer.
FROM
    "austintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n:latest"."campaign_finance_report_detail_dataset"
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 austintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.austintexas.gov. When you queryaustintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n: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)"
 

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.austintexas.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 \
  "austintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n" \
  --handler-options '{
    "domain": "data.austintexas.gov",
    "tables": {
        "campaign_finance_report_detail_dataset": "b2pc-2s8n"
    }
}'

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, austintexas-gov/campaign-finance-report-detail-dataset-b2pc-2s8n is just another Postgres schema.

Related Documentation: