Change method name for pgsql driver's ensureIdentifiersLength() to accurately describe what the method is doing

Created on 14 February 2015, about 10 years ago

Updated 24 July 2023, almost 2 years ago

Problem/Motivation

Follow-up from #2425127: Prevent PostgreSQL from creating duplicated index names within schema → . The method name ensureIdentifiersLength does not document what it does accurately and should be renamed accordingly.

  /** 
   * Make sure to limit identifiers according to PostgreSQL compiled in length.
   *
   * PostgreSQL allows in standard configuration no longer identifiers than 63
   * chars for table/relation names, indexes, primary keys, and constraints. So
   * we map all identifiers that are too long to drupal_base64hash_tag, where
   * tag is one of:
   *   - idx for indexes
   *   - key for constraints
   *   - pkey for primary keys
   *
   * @param $identifiers
   *   The arguments to build the identifier string
   * @return
   *   The index/constraint/pkey identifier
   */
  protected function ensureIdentifiersLength($identifier) {

Proposed resolution

Rename the method to "hashIdentifierLength" and update the use of that method throughout core.

Remaining tasks

Wait for 🐛 Multiple issues when PostgreSQL is used with non-public schema Fixed to be merged
Reroll with method name change from #30
Review

User interface changes

None.

API changes

Yes. However this is an internal protected method for pgsql driver.

Beta phase evaluation

📌 Task

Status

Needs work

Version

11.0 🔥

Component

PostgreSQL driver →

Last updated 7 days ago

No maintainer

Created by

🇺🇸United States mradcliffe USA

Live updates comments and jobs are added and updated live.

PostgreSQL
Particularly affects sites running on the PostgreSQL database.

DrupalNorth2015

Needs Review Queue Initiative
Used to track the progress of issues reviewed by the Drupal Needs Review Queue Initiative.

Incomplete comments

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment over 2 years ago →
🇺🇸United States smustgrave
Postponing until 🐛 Multiple issues when PostgreSQL is used with non-public schema Fixed is merged in

Then we will need a reroll to address the renaming being requested by @catch in #30 and @andypost in #33

Updating issue summary

Please do not just reroll
Status changed to Needs work almost 2 years ago4:47pm 24 July 2023
Comment almost 2 years ago →
🇺🇸United States xjm
The issue mentioned in #47 has been committed.

#30 still needs to be addressed, though. Plus, the previous patch is renaming the method without following the deprecation policy → (because the proposed change and my previous signoff predate the deprecation policy).

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024