datadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg
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 pillbox_retired_january_28_2021 table in this repository, by referencing it like:

"datadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg:latest"."pillbox_retired_january_28_2021"

or in a full query, like:

SELECT
    ":id", -- Socrata column ID
    "splscore", -- [SOURCE: SPL(DRUG LABEL)/FDA]  Score as reported by the listing firm. 
    "splimprint", -- [SOURCE: SPL(DRUG LABEL)/FDA] Imprint as reported by the listing firm
    "pillbox_imprint", -- [SOURCE: PILLBOX/NLM] If an image exists and the imprint text does not match splimprint, NLM adds the imprint presented on the image to improve the search experience.  For a small number of pills, the imprint has changed.  In those situations, NLM will include the previous imprint text.
    "splcolor", -- [SOURCE: SPL(DRUG LABEL)/FDA] Color as reported by the listing firm. Colors are limited to those specified in SPL Guidance. https://www.fda.gov/industry/structured-product-labeling-resources/spl-color
    "splcolor_text", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "pillbox_color_text", -- [SOURCE: PILLBOX/NLM] 
    "spl_strength", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "spl_ingredients", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "spl_inactive_ing", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "rxstring", -- [SOURCE: RXNORM/NLM] 
    "rxcui", -- [SOURCE: RXNORM/NLM] 
    "rxnorm_update_time", -- [SOURCE: PILLBOX/NLM] 
    "ndc9", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "ndc_labeler_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "medicine_name", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "effective_time", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "file_name", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "dosage_form", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "marketing_act_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "has_image", -- [SOURCE: PILLBOX/NLM] 
    "rxtty", -- [SOURCE: RXNORM/NLM] 
    "stale", -- [SOURCE: PILLBOX/NLM] 
    "source", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "product_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "part_num", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "part_medicine_name", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "ndc_product_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "equal_product_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "dea_schedule_name", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "image_source", -- [SOURCE: PILLBOX/NLM] 
    "version_number", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "updated", -- [SOURCE: PILLBOX/NLM] 
    "pillbox_value", -- [SOURCE: PILLBOX/NLM] 
    "id", -- [SOURCE: PILLBOX/NLM] Pillbox Engine-assigned unique identifier
    "created_at", -- [SOURCE: PILLBOX/NLM] Date record was created
    "updated_at", -- [SOURCE: PILLBOX/NLM] Date record was updated
    "spp", -- SETID + Product Code + Part Number (uniquely identifies a pill)
    "splimage", -- [SOURCE: SPL(DRUG LABEL)/FDA OR PILLBOX/NLM] 
    "approval_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "author", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "document_type", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "setid", -- [SOURCE: SPL(DRUG LABEL)/FDA] SETID of source drug label
    "splsize", -- [SOURCE: SPL(DRUG LABEL)/FDA] Size as reported by listing firm
    "pillbox_size", -- [SOURCE: SPL(DRUG LABEL)/FDA] If an NLM or VA image with a ruler exists, the size as measured on that image
    "splshape", -- [SOURCE: SPL(DRUG LABEL)/FDA] Shape as reported by the listing firm. Coded value from https://www.fda.gov/industry/structured-product-labeling-resources/spl-shape
    "splshape_text", -- [SOURCE: SPL(DRUG LABEL)/FDA] Shape as reported by the listing firm. Text value from https://www.fda.gov/industry/structured-product-labeling-resources/spl-shape
    "pillbox_shape_text", -- [SOURCE: PILLBOX/NLM] If an image exists and splshape/shape_text do not match the shape of the pill in the image, NLM adds a shape value (in text format using the FDA SPL/splshape terms) to improve search. https://www.fda.gov/industry/structured-product-labeling-resources/spl-shape 
    "pillbox_score", -- [SOURCE: PILLBOX/NLM] If an image exists and splscore does not match the score value of the pill in the image, NLM adds a score value to improve search.
    "epc_match", -- [SOURCE: PILLBOX/NLM] 
    "laberer_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "new", -- [SOURCE: PILLBOX/NLM] 
    "author_type", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "enabled", -- [SOURCE: PILLBOX/NLM] Supports Pillbox Engine
    "dea_schedule_code", -- [SOURCE: SPL(DRUG LABEL)/FDA] 
    "application_number" -- [SOURCE: SPL(DRUG LABEL)/FDA] 
FROM
    "datadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg:latest"."pillbox_retired_january_28_2021"
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 datadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg with SQL in under 60 seconds.

This repository is an "external" repository. That means it's hosted elsewhere, in this case at datadiscovery.nlm.nih.gov. When you querydatadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg: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 datadiscovery.nlm.nih.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 \
  "datadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg" \
  --handler-options '{
    "domain": "datadiscovery.nlm.nih.gov",
    "tables": {
        "pillbox_retired_january_28_2021": "crzr-uvwg"
    }
}'

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, datadiscovery-nlm-nih-gov/pillbox-retired-january-28-2021-crzr-uvwg is just another Postgres schema.