Adjusted documentation of tableList command (Java) #1288
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* provided the correct return type * extended the example
1 task
|
This might also be a viable example: try (Result<Object> result = r.db(DEFAULT_DB_NAME).tableList().run(connection)) {
result.forEach(list -> {
((List<?>) list).forEach(System.out::println);
});
} |
gabor-boros
reviewed
May 7, 2022
| {% endapibody %} | ||
|
|
||
| # Description # | ||
|
|
||
| List all table names in a database. The result is a list of strings. | ||
|
|
||
| __Example:__ List all tables of the 'test' database. | ||
| __Example:__ List all tables of the 'test' (`DEFAULT_DB_NAME`) database. |
There was a problem hiding this comment.
@clovergaze why do we need to add the 'DEAULT_DB_NAME? The examples should be copy-paste snippets.
gabor-boros
reviewed
May 7, 2022
| @@ -11,16 +11,19 @@ related_commands: | |||
| # Command syntax # | |||
|
|
|||
| {% apibody %} | |||
| db.tableList() → array | |||
| db.tableList() → TableList | |||
There was a problem hiding this comment.
Type should be ReQL type ('array')
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reason for the change
I tried to simply get the list of table names in a database and the current documentation is not helpful in that regard. The specified return type is wrong and the array with table names had to be extracted from the
Result<Object>.Description
I corrected the return type and added a useful example that shows how to really get the table names.
Checklist