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.

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

create high-level c++ api #40

Open
4 tasks
ivotron opened this issue Jun 9, 2020 · 1 comment
Open
4 tasks

create high-level c++ api #40

ivotron opened this issue Jun 9, 2020 · 1 comment

Comments

@ivotron
Copy link
Collaborator

ivotron commented Jun 9, 2020

create a high-level C++ API. A sketch (many details purposely omitted):

#include <string>
#include <skyhookdm.h>  // or something alike

int main(int argc, char **argv)
{
  // connect to a skyhookdm-capable ceph cluster
  skyhookdm::SkyhookDM sky;
  sky.init(NULL);

  // open pool
  skyhookdm::IoCtx ioctx;
  sky.ioctx_create("mypool", ioctx);
  // ...

  // buff contains an arrow table
  sky.write(ioctx, oid, "arrow", buff);

  // define query
  skyhookdm::Query query(
    columns="col2,col5",
    filters="col1 == 'foo' AND col3 > 5"
    // etc
  );

  // run query on given object and put result (arrow format) in buff
  sky.query(ioctx, oid, "arrow", query, &buff); 
}

subtasks for this:

  • implement API
  • create tests
  • document API (use doxygen)
  • create example(s) on how to create a program that uses the API (something like the above but more extensive and with lots of comments).
@ivotron
Copy link
Collaborator Author

ivotron commented Jun 9, 2020

@jlefevre @carlosmalt @xweichu @drin I updated the issue description with what we discussed today on the call. Maybe we can use this issue to refine how the API looks like

@carlosmalt carlosmalt added the project? This issue is currently not associated with a project. label Aug 11, 2020
@jlefevre jlefevre removed the project? This issue is currently not associated with a project. label Aug 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants