ny-gov/department-of-state-business-filings-beginning-m7i3-tv6j

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

"ny-gov/department-of-state-business-filings-beginning-m7i3-tv6j:latest"."department_of_state_business_filings_beginning"

or in a full query, like:

SELECT 
    ":id", -- Socrata column ID
    "total", -- The total number of certificates of the specified type that were filed in the year specified. This will include a year-to-date total for incomplete years.
    "dec", -- The number of certificates of the specified type that were filed in December of the year specified.  This will be blank until data for the month becomes available.
    "aug", -- The number of certificates of the specified type that were filed in August of the year specified.  This will be blank until data for the month becomes available.
    "jun", -- The number of certificates of the specified type that were filed in June of the year specified.  This will be blank until data for the month becomes available.
    "apr", -- The number of certificates of the specified type that were filed in April of the year specified.  This will be blank until data for the month becomes available.
    "mar", -- The number of certificates of the specified type that were filed in March of the year specified.  This will be blank until data for the month becomes available.
    "feb", -- The number of certificates of the specified type that were filed in February of the year specified.  This will be blank until data for the month becomes available.
    "jan", -- The number of certificates of the specified type that were filed in January of the year specified.  This will be blank until data for the month becomes available.
    "business_type_description", -- The name of the business type associated with the business type code.  Values: Limited Liability Company; Business Corporation; Cooperative Corporation; Limited Partnership; Not-for-profit Corporation; Registered Limited Liability Partnership; Religious Corporation; Professional Limited Liability Company.
    "authority_type_description", -- The name of the authorization type associated with the authorization type code.  Values: Domestic, Foreign, Unauthorized.
    "may", -- The number of certificates of the specified type that were filed in May of the year specified.  This will be blank until data for the month becomes available.
    "year", -- The four digit year in which the certificate type was filed.
    "nov", -- The number of certificates of the specified type that were filed in November of the year specified.  This will be blank until data for the month becomes available.
    "oct", -- The number of certificates of the specified type that were filed in October of the year specified.  This will be blank until data for the month becomes available.
    "sep", -- The number of certificates of the specified type that were filed in September of the year specified.  This will be blank until data for the month becomes available.
    "jul", -- The number of certificates of the specified type that were filed in July of the year specified.  This will be blank until data for the month becomes available.
    "description", -- The full name/description for the type of certificate filed.
    "bus_type", -- The 1 character business entity type specified for the certificate filed (fourth character; xxxB x).  Values: A, B, C, L, N, P, R, S.
    "certificate_code_description", -- The name of the certificate type associated with the certificate type code.  A full list of the certificate type descriptions appears at the end of this document.
    "mod_cert_code", -- The full 6 character certificate code for specified for the certificate filed.  This code is composed of the certificate type, authorization type, business type, and name type codes. The fifth character is a placeholder and is currently blank.
    "fict_name", -- The 1 character name type code specified for the certificate filed (sixth character; xxxx N).  Values: A, F.
    "cert_code", -- The 2 character certificate type code specified for the certificate filed (first two characters; CCxxx x).  A full list of the certificate type codes appears at the end of this document.
    "auth_type", -- The 1 character authorization type code specified for the certificate filed (third character; xxAx x).  Values: D, F, U.
    "fictitious_name_type_description" -- The name of the name type associated with the name type code.  Values: Actual Name, Fictitious.
FROM
    "ny-gov/department-of-state-business-filings-beginning-m7i3-tv6j:latest"."department_of_state_business_filings_beginning"
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/department-of-state-business-filings-beginning-m7i3-tv6j with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.ny.gov. When you queryny-gov/department-of-state-business-filings-beginning-m7i3-tv6j: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.ny.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 \
  "ny-gov/department-of-state-business-filings-beginning-m7i3-tv6j" \
  --handler-options '{
    "domain": "data.ny.gov",
    "tables": {
        "department_of_state_business_filings_beginning": "m7i3-tv6j"
    }
}'

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, ny-gov/department-of-state-business-filings-beginning-m7i3-tv6j is just another Postgres schema.

Related Documentation: