Skip to content

feat!: ComponentVersionMedia.key -> ComponentVersionMedia.path#547

Draft
kdmccormick wants to merge 1 commit intokdmccormick/keys-reffrom
kdmccormick/keys-media
Draft

feat!: ComponentVersionMedia.key -> ComponentVersionMedia.path#547
kdmccormick wants to merge 1 commit intokdmccormick/keys-reffrom
kdmccormick/keys-media

Conversation

@kdmccormick
Copy link
Copy Markdown
Member

BREAKING CHANGE: Renamed ComponentVersionMedia.key -> ComponentVersionMedia.path
BREAKING CHANGE: In create_component_version_media(...) and
look_up_component_version_media(...), renamed param key -> path.

Part of: #322

Full series of PRs:

  1. feat!: Collection.key -> Collection.collection_code #542
  2. feat!: Component.local_key -> Component.component_code #544
  3. feat!: Add Container.container_code field #545
  4. feat!: Package and Entity keys are now opaque refs #546
  5. feat!: ComponentVersionMedia.key -> ComponentVersionMedia.path #547

Testing

TBC

AI disclosure

Claude helped me write this PR. See #322 for details.

BREAKING CHANGE: Renamed ComponentVersionMedia.key -> ComponentVersionMedia.path
BREAKING CHANGE: In create_component_version_media(...) and
                 look_up_component_version_media(...), renamed param key -> path.

Part of: #322

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@kdmccormick kdmccormick force-pushed the kdmccormick/keys-media branch from ca5d407 to bb6edbd Compare April 15, 2026 10:27
Comment on lines +8 to +11
Rename the underlying DB column for ComponentVersionMedia.path from
'_key' to 'path'. Uses SeparateDatabaseAndState with RunSQL for
SQLite/MySQL compatibility. The table is named
'openedx_content_componentversionmedia' (Django default).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why do we need RunSQL here instead of just AlterField() to change the db_column?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants