Rewrite README to emphasize SQL/relational API #3756
Merged
Conversation
This file contains hidden or 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
arnaud-lacurie
force-pushed
the
docs/sql-first-readme
branch
from
d7c0d66 to
88c1e45
Compare
arnaud-lacurie
force-pushed
the
docs/sql-first-readme
branch
from
88c1e45 to
e11783d
Compare
arnaud-lacurie
force-pushed
the
docs/sql-first-readme
branch
from
6bc1a6d to
e11783d
Compare
alecgrieser
approved these changes
Nov 25, 2025
|
|
||
| ## Quick Start with SQL | ||
|
|
||
| ```java |
Collaborator
There was a problem hiding this comment.
Rather than having direct documentation here, we may want to consider updating the examples subproject with a SQL-based path. One advantage of that is that we compile and test that project as part of PRB, so it's more hardened against bit rot. But this is probably fine for now
Collaborator
Author
There was a problem hiding this comment.
I kind of like having a little bit of code in the original page, before people start diving in.
Good point about the examples subproject though, looks like it's similar to the yamsql docs files, but targeted towards Java code.
Probably not something for this PR, but good to know, thanks!
Removed link to submit documentation feedback.
alecgrieser
approved these changes
Nov 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Updates README.md to position FRL as a SQL database with JDBC support, moving protobuf-based Record Layer API to an advanced section. Includes SQL examples, schema template examples, and clarifies index-backed query execution model.