Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Orca Server API #1

Merged
merged 22 commits into from
Jun 2, 2015
Merged

Orca Server API #1

merged 22 commits into from
Jun 2, 2015

Conversation

jiffyclub
Copy link
Member

Add a Flask server that can return info from an Orca spec. Endpoints include getting summary statistics about tables and columns, seeing the source code of registered functions, and performing groupby-aggregations on tables.

The full list of routes is:

/schema
/tables
/tables/<table_name>/preview
/tables/<table_name>/describe
/tables/<table_name>/definition
/tables/<table_name>/csv
/tables/<table_name>/groupbyagg
/tables/<table_name>/columns
/tables/<table_name>/columns/<col_name>/definition
/tables/<table_name>/columns/<col_name>/describe
/tables/<table_name>/columns/<col_name>/csv
/injectables
/injectables/<inj_name>/repr
/injectables/<inj_name>/definition
/broadcasts
/broadcasts/<cast_name>/<onto_name>/definition
/steps
/steps/<step_name>/definition

These are documented in the server file.

@jiffyclub
functions for accessing raw registered tables
b66ec62 
get_table only returns DataFrameWrappers and for some applications
we're going to want to know about and inspect what was actually
registered with orca, which means getting access to the original
DataFrame or function wrapper.
@jiffyclub
Utility for getting function source data
2cc1026
@jiffyclub
Add ability to get func info for table funcs
7032f88
@jiffyclub
make is_table and get_raw_table public functions
68d57a7
@jiffyclub
make table_type a public function
af1011b
@jiffyclub
make list_columns_for_table function public
0e6d3f6
@jiffyclub
methods for getting type of a column
ce51afe
@jiffyclub
function for getting a raw wrapped column
736b2b8
@jiffyclub
method for getting column function metadata
5fc19b0
@jiffyclub
function for checking existence of an injectable
32601fe
@jiffyclub
function for checking injectable type
b620266
@jiffyclub
function for getting injectable function metadata
a16bce2
@jiffyclub
new function for getting a single broadcast
50d95e2 
So the join rules can be inspected.
Also changed _Broadcast to Broadcast and added an is_broadcast func.
@jiffyclub
Add function for checking for the existence of a step
c4a90c2
@jiffyclub
function for getting step function metadata
1f3d98d
@jiffyclub
adding server file
aae8de8 
[ci skip]
@jiffyclub
additional docstrings for server
d6c38bd 
[ci skip]
@fscottfoti
Copy link
Contributor

@cvanegas this is the start of the Orca json api.

@jiffyclub
Copy link
Member Author

This now includes a CLI to start the server, but before a release I'll need to update the CLI to accept options for tuning the server like whether debug mode is on, what port to use, etc.

jiffyclub added a commit that referenced this pull request Jun 2, 2015
@jiffyclub
Merge pull request #1 from synthicity/orca-api
eacc3e4 
Orca Server API
@jiffyclub jiffyclub merged commit eacc3e4 into master Jun 2, 2015
@jiffyclub jiffyclub deleted the orca-api branch June 2, 2015 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@jiffyclub @fscottfoti