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

Add Database Component #14995

Merged
merged 45 commits into from
Oct 19, 2022
Merged

Add Database Component #14995

merged 45 commits into from
Oct 19, 2022

Conversation

tchaton
Copy link
Contributor

@tchaton tchaton commented Oct 4, 2022

What does this PR do?

This component provides a simple way to add a SQLite database to your app using the SQLModel dependency.

This component was created from the work done in the Lightning HPO repo and it was re-used in the Echo App.

from sqlmodel import Field, SQLModel

from lightning import LightningApp, LightningFlow
from lightning_app.components.database import Database, DatabaseClient


class CounterModel(SQLModel, table=True):
    __table_args__ = {"extend_existing": True}

    id: int = Field(default=None, primary_key=True)
    count: int


class Flow(LightningFlow):
    def __init__(self):
        super().__init__()
        self.db = Database(models=[CounterModel])
        self._client = None
        self.counter = 0

    def run(self):
        self.db.run()

        if not self.db.alive():
            return

        if self.counter == 0:
            self._client = DatabaseClient(model=CounterModel, db_url=self.db.url)
            self._client.reset_database()

        assert self._client

        rows = self._client.select_all()

        print(f"{self.counter}: {rows}")

        if not rows:
            self._client.insert(CounterModel(count=0))
        else:
            row: CounterModel = rows[0]
            row.count += 1
            self._client.update(row)

        if self.counter >= 100:
            row: CounterModel = rows[0]
            self._client.delete(row)
            self._client.delete_database()
            self._exit()

        self.counter += 1


app = LightningApp(Flow())

Fixes #<issue_number>

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

cc @Borda

@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Oct 4, 2022
@mergify mergify bot added the has conflicts label Oct 6, 2022
@mergify mergify bot removed the has conflicts label Oct 7, 2022
@tchaton tchaton requested review from manskx and lantiga October 12, 2022 15:24
Copy link
Collaborator

@lantiga lantiga left a comment

Choose a reason for hiding this comment

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

Minor change (take a state variable to private)

src/lightning_app/components/database/server.py Outdated Show resolved Hide resolved
src/lightning_app/components/database/utilities.py Outdated Show resolved Hide resolved
@mergify mergify bot added has conflicts and removed ready PRs ready to be merged labels Oct 19, 2022
src/lightning_app/components/database/server.py Outdated Show resolved Hide resolved
src/lightning_app/components/database/server.py Outdated Show resolved Hide resolved
src/lightning_app/components/database/utilities.py Outdated Show resolved Hide resolved
src/lightning_app/utilities/serializable.py Outdated Show resolved Hide resolved
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Oct 19, 2022
@tchaton tchaton disabled auto-merge October 19, 2022 17:26
@tchaton tchaton enabled auto-merge (squash) October 19, 2022 17:55
@tchaton tchaton modified the milestones: v1.9, v1.8 Oct 19, 2022
@tchaton tchaton merged commit 979d728 into master Oct 19, 2022
@tchaton tchaton deleted the upstream_hpo branch October 19, 2022 19:52
@tchaton tchaton mentioned this pull request Oct 20, 2022
12 tasks
tchaton added a commit that referenced this pull request Oct 24, 2022
@tchaton tchaton added the bug Something isn't working label Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app (removed) Generic label for Lightning App package bug Something isn't working ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants