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 daily_corporation_and_other_entity_filing_data table in this repository, by referencing it like:
"ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh:latest"."daily_corporation_and_other_entity_filing_data"or in a full query, like:
SELECT
":id", -- Socrata column ID
"new_stock_num_shrs_5", -- Number of shares of stock
"filer_zip4", -- Filer’s Address Zip 4
"old_stock_num_shrs_3", -- Number of shares of stock
"for_juris", -- The jurisdiction (state or country) in which the entity was formed
"new_stock_num_shrs_2", -- Number of shares of stock
"old_stock_val_shr_1", -- Par Value of each share having a par value
"new_stock_val_shr_2", -- Par Value of each share having a par value
"law", -- The law under which the filing was made
"mrgr_const_name2", -- Name constituent entity participating in a merger or consolidation
"pre_corp_name", -- Previous name of an entity
"new_stock_val_shr_5", -- Par Value of each share having a par value
"new_stock_val_shr_1", -- Par Value of each share having a par value
"old_stock_type_5", -- Type of Stock (“par” or “no par value”)
"new_stock_val_shr_3", -- Par Value of each share having a par value
"new_stock_val_shr_4", -- Par Value of each share having a par value
"mod_certcode", -- The Mod Cert Code, taken together with the information in the LAW field, is a description of the type of filing represented by this record.
"new_stock_type_5", -- Type of Stock (“par” or “no par value”)
"new_stock_num_shrs_4", -- Number of shares of stock
"nfp_type", -- The category of the Not-for-Profit Corporation; either “Charitable” or “Non-Charitable”
"old_stock_val_shr_3", -- Par Value of each share having a par value
"old_stock_val_shr_5", -- Par Value of each share having a par value
"sop_city", -- City, town or village in the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"old_stock_type_2", -- Type of Stock (“par” or “no par value”)
"new_stock_num_shrs_3", -- Number of shares of stock
"old_stock_type_1", -- Type of Stock (“par” or “no par value”)
"sop_zip4", -- ZIP 4 in the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"mrgr_const_name1", -- Name of constituent entity participating in a merger or consolidation
"orig_lp_name", -- Original name of a Limited Partnership that has filed a Certificate of Adoption
"new_stock_type_4", -- Type of Stock (“par” or “no par value”)
"old_stock_val_shr_4", -- Par Value of each share having a par value
"eff_date", -- Effective Date of a Filing
"mrgr_const_name3", -- Name of constituent entity participating in a merger or consolidation
"old_stock_num_shrs_2", -- Number of shares of stock
"for_inc_date", -- Date on which foreign entity was first formed in the jurisdiction of formation
"dura_date", -- The date on which a corporation is dissolved by expiration of its period of duration or the date after which the Limited Liability Company or Limited Partnership is to dissolve
"old_stock_num_shrs_1", -- Number of shares of stock
"fictitious_name", -- Fictitious name of a foreign entity, if any
"corp_name", -- The entity’s name. For assumed name filings, the assumed name appears instead
"filing_type", -- Type of Filing (e.g. certificate of incorporation)
"new_stock_type_2", -- Type of Stock (“par” or “no par value”)
"old_stock_type_4", -- Type of Stock (“par” or “no par value”)
"filer_name", -- The name of the filer of the document
"sop_zip5", -- ZIP 5 in the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"film_num", -- ID Number assigned to the image of the document
"filing_date", -- The date the document was filed by the Department of State
"filer_addr1", -- Filer’s Address Line 1
"filer_country", -- Filer’s Address Country
"old_stock_num_shrs_4", -- Number of shares of stock
"old_stock_type_3", -- Type of Stock (“par” or “no par value”)
"approved_date", -- The date the document was approved for filing
"old_stock_num_shrs_5", -- Number of shares of stock
"new_stock_num_shrs_1", -- Number of shares of stock
"old_stock_val_shr_2", -- Par Value of each share having a par value
"filer_zip5", -- Filer’s Address Zip 5
"filer_city", -- Filer’s Address City, Town or Village
"filer_addr2", -- Filer’s Address Line 2
"filer_state", -- Filer’s Address State
"sop_name", -- The name in the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"dos_id", -- DOS identification number for the entity
"sop_addr1", -- Address Line 1 of the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"sop_addr2", -- Address Line 2 of the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"new_stock_type_3", -- Type of Stock (“par” or “no par value”)
"sop_state", -- State in the address to which the Secretary of State will mail a copy of any process against the entity served upon the Secretary of State
"cnty_prin_ofc", -- The county within New York State in which the office of the entity is to be located.
"new_stock_type_1", -- Type of Stock (“par” or “no par value”)
"entity_type" -- Type of entity (e.g., business corporation)
FROM
"ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh:latest"."daily_corporation_and_other_entity_filing_data"
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/daily-corporation-and-other-entity-filing-data-k4vb-judh 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 ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh: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 ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judhCheckout 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 ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh:latestThis will download all the objects for the latest tag of ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh 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 ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh: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 ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh: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, ny-gov/daily-corporation-and-other-entity-filing-data-k4vb-judh is just another Postgres schema.