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-24.1: sql: alter primary key hangs if index references exist #124323

Merged
merged 1 commit into from
May 21, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented May 17, 2024

Backport 1/1 commits from #124132 on behalf of @fqazi.

/cc @cockroachdb/release


Previously, ALTER PRIMARY KEY could hang if an index reference existed from either a view or function using the index selection syntax. This was becasue neither the declarative schema changer or legacy schema changer support updating these references. To address this, this patch will prevent ALTER PRIMARY KEY if such references exist to any indexes that will be recreated.

Fixes: #123017
Release note (bug fix): ALTER PRIMARY KEY could hang if the table had any indexes which were referred to by views or functions using the force index syntax.


Release justification: low risk and prevents users from running into an unsupported schema change scenario that will lead to requiring a manual help from support

@blathers-crl blathers-crl bot requested a review from a team as a code owner May 17, 2024 04:06
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-24.1-124132 branch from 1601d8b to 29c92ec Compare May 17, 2024 04:06
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels May 17, 2024
@blathers-crl blathers-crl bot requested review from annrpom, fqazi and rafiss May 17, 2024 04:06
Copy link
Author

blathers-crl bot commented May 17, 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 May 17, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@fqazi fqazi requested a review from mgartner May 21, 2024 13:35
Copy link
Collaborator

@mgartner mgartner left a comment

Choose a reason for hiding this comment

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

:lgtm: just pointed out a few typos you may want to address in a future PR on master

Reviewed 4 of 4 files at r1, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @annrpom, @blathers-crl[bot], and @fqazi)


pkg/sql/alter_primary_key.go line 452 at r1 (raw file):

			indexesToRewrite = append(indexesToRewrite, idx)
		}
		// If this index is referenced by any other objects, then we wil

nit: "wil" => "will"


pkg/sql/schemachanger/scbuild/internal/scbuildstmt/alter_table_alter_primary_key.go line 690 at r1 (raw file):

	scpb.ForEachSecondaryIndex(publicTableElts, func(_ scpb.Status, _ scpb.TargetStatus, idx *scpb.SecondaryIndex) {
		out := makeIndexSpec(b, idx.TableID, idx.IndexID)
		// If this index is referenced by any other objects, then we wil

nit: "wil" => "will"

Copy link
Collaborator

@fqazi fqazi left a comment

Choose a reason for hiding this comment

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

@mgartner TFTR. Yeah, let me get a PR open for those.

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @annrpom and @blathers-crl[bot])

Previously, ALTER PRIMARY KEY could hang if an index reference existed
from either a view or function using the index selection syntax. This
was becasue neither the declarative schema changer or legacy schema
changer support updating these references. To address this, this patch
will prevent ALTER PRIMARY KEY if such references exist to any indexes
that will be recreated.

Fixes: #123017

Release note (bug fix): ALTER PRIMARY KEY could hang if the table had
any indexes which were referred to by views or functions using the force
index syntax.
Copy link
Collaborator

@fqazi fqazi left a comment

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @annrpom)


pkg/sql/alter_primary_key.go line 452 at r1 (raw file):

Previously, mgartner (Marcus Gartner) wrote…

nit: "wil" => "will"

Done.


pkg/sql/schemachanger/scbuild/internal/scbuildstmt/alter_table_alter_primary_key.go line 690 at r1 (raw file):

Previously, mgartner (Marcus Gartner) wrote…

nit: "wil" => "will"

Done.

@fqazi fqazi force-pushed the blathers/backport-release-24.1-124132 branch from 29c92ec to 06272b5 Compare May 21, 2024 17:28
@fqazi fqazi merged commit eb872c6 into release-24.1 May 21, 2024
19 of 20 checks passed
@fqazi fqazi deleted the blathers/backport-release-24.1-124132 branch May 21, 2024 20:04
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 blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants