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

Implement schemas.patch RPC method #3628

Merged
merged 4 commits into from
Jun 20, 2024
Merged

Implement schemas.patch RPC method #3628

merged 4 commits into from
Jun 20, 2024

Conversation

seancolsen
Copy link
Contributor

Fixes #3627

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@seancolsen seancolsen added this to the Beta milestone Jun 17, 2024
@seancolsen seancolsen added the pr-status: review A PR awaiting review label Jun 17, 2024
mathemancer
mathemancer approved these changes Jun 19, 2024
View reviewed changes
Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

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

I found a couple of documentation typos. Feel free to merge once those are fixed.

db/sql/00_msar.sql
CREATE OR REPLACE FUNCTION
__msar.comment_on_schema(sch_name text, comment_ text) RETURNS TEXT AS $$/*
Change the description of a schema, returning command executed.
Descriptions are removed by passing an empty string. Passing a NULL description will cause
Copy link
Contributor

Choose a reason for hiding this comment

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

Huh. Apparently NULL and empty string descriptions are equivalent as far as PostgreSQL is concerned. I didn't know that.

db/sql/00_msar.sql Outdated
__msar.comment_on_schema(sch_name text, comment_ text) RETURNS TEXT AS $$/*
Change the description of a schema, returning command executed.
Descriptions are removed by passing an empty string. Passing a NULL description will cause
this function to return NULL withou doing anything.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
this function to return NULL withou doing anything.
this function to return NULL without doing anything.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 1c1b55a

db/sql/00_msar.sql Outdated
Args:
sch_id: The OID of the schema.
comment_: The new comment, UNQUOTED
sch_id: The name of the schema.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
sch_id: The name of the schema.
sch_name: The name of the schema, UNQUOTED.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 1c1b55a

db/sql/test_00_msar.sql
RETURN NEXT has_schema('altered');
END;
$$ LANGUAGE plpgsql;
-- Edge case: setting the description to null doesn't actually remove it. This behavior is
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's fine. At some point, we should put some effort into making this behavior consistent across the code base.

@seancolsen seancolsen added this pull request to the merge queue Jun 20, 2024
Merged via the queue into develop with commit 671db80 Jun 20, 2024
39 checks passed
@seancolsen seancolsen deleted the schemas_patch branch June 20, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mathemancer mathemancer mathemancer approved these changes

Assignees

@mathemancer mathemancer

Labels
pr-status: review A PR awaiting review
Projects
None yet
Milestone
Beta
Development

Successfully merging this pull request may close these issues.

Implement schemas.patch RPC method
2 participants
@seancolsen @mathemancer