Skip to content

docs(providers): five docs cite getPlaceholder(), a method deleted in #304 #640

Description

@cevheri

Five provider docs describe getPlaceholder() as a member of SQLBaseProvider. That method does not exist. It was deleted in #304 (02578ff7), and grep -rn getPlaceholder src/ returns nothing today, so every one of these sentences describes a method the reader cannot find.

Measured on main at 53090b0:

Site What it claims
docs/providers/mssql.md:66 "Bind placeholders are @p1, @p2, … (getPlaceholder() from the base)"
docs/providers/oracle.md:472 "Bind parameters use Oracle's :1-style placeholders (getPlaceholder() from the base)"
docs/providers/druid.md:127 inherited-member row: "Returns ?, which is exactly what Druid's positional parameters use"
docs/providers/druid.md:561 "So query(sql, params) binds rather than refuses, and getPlaceholder() needs no override"
docs/providers/elasticsearch.md:126 inherited-member row: "Inherited and never reached: positional parameters are refused outright"
docs/providers/opensearch.md:131 inherited-member row: "Inherited and never reached: positional parameters are refused outright"

The rule for the fix: keep the fact, drop the dead name. Deleting these lines outright would lose real, engine-specific information that is still true. Each site says something about how that engine binds parameters, and only the reference to a non-existent method is wrong:

  • mssql and oracle: the placeholder syntax (@p1, :1) is still what the provider sends. Say so without attributing it to a base-class method.
  • druid: positional parameters really execute, and query(sql, params) really binds. Still true.
  • elasticsearch and opensearch: positional parameters are refused outright, and their §3.11 explains it. Still true.

docs/providers/clickhouse.md in #639 is the model to copy. It had the same row; the fix removed the row and kept the point it carried as a sentence under the table, so the reader still learns that ClickHouse binds only named {name:Type} parameters and that query() throws rather than send an unbound ?. Compare docs/providers/clickhouse.md before and after 53090b0.

Verifying. grep -rn getPlaceholder docs/ must return nothing when you are done. bun test tests/unit/provider-docs-monitoring-citations.test.ts must stay green: mssql.md and oracle.md are both in that file's NAMED_CITATIONS list, so their whole file is already in scope for the no-line-number test. Note what that does not cover, and why this issue exists at all: nothing in the suite asserts that a method a doc cites by name still exists in the source, so these six sites went stale silently.

Scope note. docs/providers/druid.md also has 18 stale line-number citations, tracked separately in #590. The two overlap in that file. Either fix works alone, whichever lands first; if you take both, say so on both issues so nobody duplicates the work.

Activity

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershacktoberfestCurated for Hacktoberfest; pick up cold, tests required

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions