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

Developer guide for new structure data source integration #966

Merged
merged 10 commits into from
Aug 26, 2023
Merged

Developer guide for new structure data source integration #966

merged 10 commits into from
Aug 26, 2023
+103 −3

Conversation

xzdandy
Copy link
Collaborator

@xzdandy xzdandy commented Aug 26, 2023

No description provided.

@xzdandy xzdandy linked an issue Aug 26, 2023 that may be closed by this pull request
Developer Guide for New Data Source Intergration #964
Closed
2 tasks
@xzdandy xzdandy added this to the v0.3.3 milestone Aug 26, 2023
@xzdandy xzdandy requested a review from jiashenC August 26, 2023 08:03
@xzdandy
Copy link
Collaborator Author

xzdandy commented Aug 26, 2023

@jiashenC Please review the documentation. Shall we ask for test cases when adding a new data source integration? If so, how do we do that given many of them needs to setup a backend server. Thanks!

@jiashenC
Copy link
Member

@jiashenC Please review the documentation. Shall we ask for test cases when adding a new data source integration? If so, how do we do that given many of them needs to setup a backend server. Thanks!

Yeah, for open sourced engine, we can probably setup server in CI as Postgres. For other commercial ones, we need to think of other solutions.

@jiashenC jiashenC changed the base branch from master to staging August 26, 2023 16:04
jiashenC
jiashenC reviewed Aug 26, 2023
View reviewed changes
Copy link
Member

@jiashenC jiashenC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall it looks good.

  1. We probably need to explain where to add requirements.txt for installing native database-related libraries and how it is handled by us.
  2. Just check the consistency of lower case / upper case for MyDB example.

xzdandy
xzdandy commented Aug 26, 2023
View reviewed changes
docs/source/contribute/new-data-source.rst

.. note::

EvaDB will only install a data source's specific dependency libraries when a connection to the data source is created by the user via, e.g., `CREATE DATABASE mydb_source WITH ENGINE = "mydb";`.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jiashenC This is what I have for requirements.txt. Could you help elaborate on that? Thanks!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, i see. I missed that part.

@xzdandy
Copy link
Collaborator Author

xzdandy commented Aug 26, 2023 •
edited
Loading

Remove the unit test case requirements. We will add back when we have one.

@xzdandy xzdandy merged commit df687d7 into staging Aug 26, 2023
@xzdandy xzdandy deleted the 964-developer-guide-for-new-data-source-intergration branch August 26, 2023 18:18
aryan-rajoria pushed a commit that referenced this pull request Aug 27, 2023
@xzdandy @aryan-rajoria
Developer guide for new structure data source integration (#966)
51e2e0f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jiashenC jiashenC jiashenC approved these changes

Assignees
No one assigned
Labels
Documentation 📗
Projects
None yet
Milestone
v0.3.3
Development

Successfully merging this pull request may close these issues.

Developer Guide for New Data Source Intergration
2 participants
@xzdandy @jiashenC