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.

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

release-23.2: sql: collect table statistics on virtual computed columns #120923

Merged
merged 3 commits into from Mar 27, 2024

Conversation

michae2
Copy link
Collaborator

@michae2 michae2 commented Mar 23, 2024

Backport:

Please see individual PRs for details.

/cc @cockroachdb/release

Release justification: high priority business need for the functionality which cannot wait until the next release.

@michae2 michae2 requested review from a team as code owners March 23, 2024 04:41
Copy link

blathers-crl bot commented Mar 23, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL and one additional
    TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Mar 23, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@michae2
Copy link
Collaborator Author

michae2 commented Mar 23, 2024

Are all of the changes protected via a flag or option, new syntax, an environment variable or default-disabled cluster setting?

Yes, all of the changes are behind cluster setting sql.stats.virtual_computed_columns.enabled which is disabled by default in these backports.

What are the risks to backporting this change? Can the risks of backporting be mitigated?

Main risk is that with sql.stats.virtual_computed_columns.enabled turned on we build an invalid distsql plan for stats collection, which could prevent statistics collection on some tables if it were to happen.

What are the risks to not backporting?

Statistics estimates for queries on indexed virtual computed columns will continue to be inaccurate, possibly prohibiting creation of indexes on virtual computed columns.

Does this change really need to be backported? Or can it reasonably wait until the next major release to be addressed?

It cannot wait.

@michae2
Copy link
Collaborator Author

michae2 commented Mar 24, 2024

The backport was clean, there were only minor differences from master:

  • sql.stats.virtual_computed_columns.enabled is false by default
  • had to add SET CLUSTER SETTING sql.stats.virtual_computed_columns.enabled = true to distsql_stats and distsql_misc logic tests

@michae2
Copy link
Collaborator Author

michae2 commented Mar 25, 2024

One failure is unrelated flake #120817. I'll look into the other failure this morning.

Add rendering of virtual computed column expressions to the CREATE
STATISTICS distsql plan. This rendering should always be added as post
processors on the TableReader nodes that feed the Samplers.

With this change we now collect table statistics on virtual computed
columns. A future PR will make use of the statistsics in statistics
builder.

Collection of partial statistics (USING EXTREMES) on virtual computed
columns simply works after this change because partial statistics
collection utilizes secondary indexes, where virtual computed columns
are regular stored columns.

Informs: cockroachdb#68254

Epic: CRDB-8949

Release note (sql change): Add a new cluster setting,
`sql.stats.virtual_computed_columns.enabled`, which when set enables
collection of table statistics on virtual computed columns.
This function checks whether an expression supports distributed
execution. The name was a little ambiguous, especially in the giant
sql package.

Epic: None
Release note: None
Defensively guard against non-public mutation columns when building
statistics requests for CREATE STATISTICS / ANALYZE.

Fixes: cockroachdb#118537

Release note: None
@michae2
Copy link
Collaborator Author

michae2 commented Mar 27, 2024

Extended CI failure is a flake, this is RFAL.

@michae2 michae2 merged commit 39c1e34 into cockroachdb:release-23.2 Mar 27, 2024
5 of 6 checks passed
@michae2 michae2 deleted the backport23.2-118241-118930 branch March 27, 2024 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants