mathesar-foundation / mathesar

Web application providing an intuitive user experience to databases.
https://mathesar.org/
GNU General Public License v3.0
2.28k stars 316 forks source link

Implement `tables.list` rpc endpoint #3599

Closed Anish9901 closed 1 month ago

Anish9901 commented 1 month ago

Fixes #3600

Checklist

- [x] My pull request has a descriptive title (not a vague title like `Update index.md`). - [x] My pull request targets the `develop` branch of the repository - [x] My commit messages follow [best practices][best_practices]. - [x] My code follows the established code style of the repository. - [x] I added tests for the changes I made (if applicable). - [x] I added or updated documentation (if applicable). - [x] I tried running the project locally and verified that there are no visible errors. [best_practices]:https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53 ## 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. ```
Anish9901 commented 1 month ago

@mathemancer, @seancolsen As of now the tables.list endpoint returns the schema oid with each tableinfo json blob, however, it is debatable whether or not we want to have that, as`tables.listfilters tables based on a schema oid rather than database id. In other words, we already have the schema oid that will be returned in each json object returned bytables.list` endpoint. Any thoughts about whether or not we want to include schema oid in each json object?

seancolsen commented 1 month ago

@Anish9901

whether or not we want to include schema oid in each json object?

Good question. I would lean towards keeping it. I don't see much harm in having it there. And the data structures in the front end do actually appear to use that property as returned from the REST API. It's possible it would be easy to refactor that stuff out of the front end. But it would take me some time to investigate deeply enough to form a definitive answer.