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 state_of_vermont_employee_survey_engagement_score table in this repository, by referencing it like:
"vermont-gov/state-of-vermont-employee-survey-engagement-score-vymh-5p4g:latest"."state_of_vermont_employee_survey_engagement_score"or in a full query, like:
SELECT
":id", -- Socrata column ID
"year", -- Represents the year the Employee Engagement Survey was taken by State of Vermont Executive Branch Classified and Exempt employees
"satisfaction", -- Satisfaction – work and employer questions from the Employee Engagement Survey Q4. I enjoy performing the day-to-day work of my job. Q5. The work I perform is meaningful and rewarding. Q6. I would recommend the State of Vermont to others as a great place to work Q41. I feel that working for the State of Vermont provides me with a solid career path. Q45. In general, I am satisfied with my job.
"alignment", -- Alignment – understanding the link between one’s job and the organization’s mission questions on the Employee Engagement Survey Q1. I understand my job duties and responsibilities. Q2. I understand the work, goals, and mission of my department or agency. Q3. The work I perform is linked to my department or agency meeting its goals and mission
"communication", -- Communication – value employee voices, ideas, opinions questions on the Employee Engagement Survey Q7. Management and senior leadership communicates important information effectively. Q8. I have an opportunity to provide feedback to management and senior leadership. Q9. I am encouraged to share ideas on improving either service delivery or business process efficiency. Q16. I feel I can communicate honestly and openly in my workplace.
"balance", -- Balance – work-life questions on the Employee Engagement Survey Q33. The amount of work I am expected to perform is reasonable. Q34. My job allows a good balance between work and my personal life
"peers", -- Peers – positive relationships in the workplace questions on the Employee Engagement Survey Q12. The people I work with treat each other respectfully. Q13. The people I work with care about me. Q14. My fellow employees are committed to doing good work. Q15. The employees in my work group work well together as a team.
"engagement_score_summary", -- The overall engagement score is an average of the overall data from the seven component question sets - Growth, Alignment, Supervisor, Peers, Balance, Communication and Satisfaction
"supervisor", -- Supervisor – support, recognition and feedback questions on the Employee Engagement Survey Q20. My supervisor clearly explains my job performance expectations. Q21. My supervisor regularly provides me with timely and useful feedback. Q22. My supervisor gives me an opportunity to do my best work. Q23. I am satisfied with the recognition I receive from my supervisor for my work. Q24. My supervisor treats employees fairly and respectfully. Q25. My supervisor seems to care about me as a person.
"growth" -- Growth – personal growth and development questions on Employee Engagement Survey Q26. My supervisor provides the help I need to improve my job performance. Q27. I have an opportunity to learn and grow professionally Q28. I receive the training I need to perform my job. Q29. My supervisor and I discuss and plan my career development.
FROM
"vermont-gov/state-of-vermont-employee-survey-engagement-score-vymh-5p4g:latest"."state_of_vermont_employee_survey_engagement_score"
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 vermont-gov/state-of-vermont-employee-survey-engagement-score-vymh-5p4g with SQL in under 60 seconds.
This repository is an "external" repository. That means it's hosted elsewhere, in this case at data.vermont.gov. When you queryvermont-gov/state-of-vermont-employee-survey-engagement-score-vymh-5p4g: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
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.vermont.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 \
"vermont-gov/state-of-vermont-employee-survey-engagement-score-vymh-5p4g" \
--handler-options '{
"domain": "data.vermont.gov",
"tables": {
"state_of_vermont_employee_survey_engagement_score": "vymh-5p4g"
}
}'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, vermont-gov/state-of-vermont-employee-survey-engagement-score-vymh-5p4g is just another Postgres schema.