Skip to content

doc/radosgw: Redd up s3select.rst as followup to #49411#50384

Merged
zdover23 merged 1 commit intoceph:mainfrom
anthonyeleven:anthonyeleven/tweak-50374
Mar 7, 2023
Merged

doc/radosgw: Redd up s3select.rst as followup to #49411#50384
zdover23 merged 1 commit intoceph:mainfrom
anthonyeleven:anthonyeleven/tweak-50374

Conversation

@anthonyeleven
Copy link
Contributor

@anthonyeleven anthonyeleven commented Mar 5, 2023

doc/radosgw: Redd up s3select.rst as followup to #49411

Caps, whitespace, wording, formatting, all the usual OCD.

Signed-off-by: Anthony D'Atri anthonyeleven@users.noreply.github.com

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@zdover23 zdover23 mentioned this pull request Mar 5, 2023
14 tasks
@cbodley cbodley requested a review from galsalomon66 March 5, 2023 17:41
| on each run with a different dataset(random).
| (2) Compares results of queries whose syntax is different but which are semantically equivalent.
| This kind of test validates that different runtime flows produce an identical result
| on each run with a different, random dataset.
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

| These objects and arrays can be nested within each other without any limitations.
| upon using SQL to query a specific value in a JSON document, the user needs to use a specific syntax to describe the location of the value.
| When using SQL to query a specific value in a JSON document, the user needs to use a specific syntax to describe the location of the value.
| This is because the standard "select column from object" syntax will not work.
Copy link
Contributor

Choose a reason for hiding this comment

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

this line(556) may removed.

| upon using SQL to query a specific value in a JSON document, the user needs to use a specific syntax to describe the location of the value.
| When using SQL to query a specific value in a JSON document, the user needs to use a specific syntax to describe the location of the value.
| This is because the standard "select column from object" syntax will not work.
| Instead, the user must use a path in the SELECT statement to tell the JSON reader where the value is located.
Copy link
Contributor

Choose a reason for hiding this comment

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

and use the following:

The user must use a path in the SELECT statement to tell the JSON reader where the value is located.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've recast this in a slightly different way, PTAL. I was hesitant to do too much restructuring since my SQL-fu is weak.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for reviewing and editing.

there is much SQL examples for the use case of JSON, in this document and also in the Repo itself.
i hope it is enough.

@anthonyeleven anthonyeleven force-pushed the anthonyeleven/tweak-50374 branch from 768230c to b1be592 Compare March 5, 2023 23:44
| This is because the standard "select column from object" syntax will not work.
| Instead, the user must use a path in the SELECT statement to tell the JSON reader where the value is located.
| When using SQL to query a specific value in a JSON document, the client must specify the location of the value
| via a path in the SELECT statement.
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

| - escape character disables any special characters, except for row delimiter.
| The ``s3-select`` engine contains a CSV parser, which parses s3-objects as follows.
| - Each row ends with ``row-delimiter``.
| - ``field-separator`` separates adjacent columns, successive ``field separator``s define a NULL column.
Copy link
Contributor

@zdover23 zdover23 Mar 6, 2023

Choose a reason for hiding this comment

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

@anthonyeleven: I suspect that the s after field separator has to be escaped, but I haven't tested it locally, so this is just a self-educated guess. So:

s|field separator| field separator `` \s|

I suspect.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I rephrase to avoid the uncertainty, ptal

Copy link
Contributor

Choose a reason for hiding this comment

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

That did it. It got past the checks.

I'm going to merge this and create backports.

Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
@anthonyeleven anthonyeleven force-pushed the anthonyeleven/tweak-50374 branch from b1be592 to 78b42ee Compare March 6, 2023 23:54
@zdover23 zdover23 merged commit 96019dd into ceph:main Mar 7, 2023
@zdover23
Copy link
Contributor

zdover23 commented Mar 7, 2023

#50414 - Reef backport
#50415 - Quincy backport
#50416 - Pacific backport

@anthonyeleven anthonyeleven deleted the anthonyeleven/tweak-50374 branch December 8, 2025 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants