Skip to content

Commit

Permalink
Exposing the Oid of PostgreSQL types (#2507)
Browse files Browse the repository at this point in the history
* Exposing the Oid of PostgreSQL types

* Do not panic if OID is not set

* Update sqlx-postgres/src/type_info.rs

Co-authored-by: Austin Bonander <austin.bonander@gmail.com>

* cargo fmt

---------

Co-authored-by: Austin Bonander <austin.bonander@gmail.com>
  • Loading branch information
Razican and abonander authored Jun 30, 2023
1 parent c2e54ea commit 87ff645
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions sqlx-postgres/src/type_info.rs
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,25 @@ impl PgTypeInfo {
self.0.kind()
}

/// Returns the OID for this type, if available.
///
/// The OID may not be available if SQLx only knows the type by name.
/// It will have to be resolved by a `PgConnection` at runtime which
/// will yield a new and semantically distinct `TypeInfo` instance.
///
/// This method does not perform any such lookup.
///
/// ### Note
/// With the exception of [the default `pg_type` catalog][pg_type], type OIDs are *not* stable in PostgreSQL.
/// If a type is added by an extension, its OID will be assigned when the `CREATE EXTENSION` statement is executed,
/// and so can change depending on what extensions are installed and in what order, as well as the exact
/// version of PostgreSQL.
///
/// [pg_type]: https://github.com/postgres/postgres/blob/master/src/include/catalog/pg_type.dat
pub fn oid(&self) -> Option<Oid> {
self.0.try_oid()
}

#[doc(hidden)]
pub fn __type_feature_gate(&self) -> Option<&'static str> {
if [
Expand Down

0 comments on commit 87ff645

Please sign in to comment.