Skip to main content

PostgresAdapter

Struct PostgresAdapter 

Source
pub struct PostgresAdapter { /* private fields */ }
Expand description

PostgreSQL database adapter with connection pooling.

Uses deadpool-postgres for connection pooling and tokio-postgres for async queries.

§Example

use fraiseql_core::db::postgres::PostgresAdapter;
use fraiseql_core::db::{DatabaseAdapter, WhereClause, WhereOperator};
use serde_json::json;

// Create adapter with connection string
let adapter = PostgresAdapter::new("postgresql://localhost/mydb").await?;

// Execute query
let where_clause = WhereClause::Field {
    path: vec!["email".to_string()],
    operator: WhereOperator::Icontains,
    value: json!("example.com"),
};

let results = adapter
    .execute_where_query("v_user", Some(&where_clause), Some(10), None)
    .await?;

println!("Found {} users", results.len());

Implementations§

Source§

impl PostgresAdapter

Source

pub async fn new(connection_string: &str) -> Result<Self>

Create new PostgreSQL adapter with default pool configuration.

§Arguments
  • connection_string - PostgreSQL connection string (e.g., “postgresql://localhost/mydb”)
§Errors

Returns FraiseQLError::ConnectionPool if pool creation fails.

§Example
let adapter = PostgresAdapter::new("postgresql://localhost/mydb").await?;
Source

pub async fn with_pool_config( connection_string: &str, _min_size: usize, max_size: usize, ) -> Result<Self>

Create new PostgreSQL adapter with custom pool configuration.

§Arguments
  • connection_string - PostgreSQL connection string
  • min_size - Minimum size hint (not enforced by deadpool-postgres)
  • max_size - Maximum number of connections in pool
§Errors

Returns FraiseQLError::ConnectionPool if pool creation fails.

§Note

min_size is accepted for API compatibility but deadpool-postgres uses lazy initialization with dynamic pool sizing up to max_size.

Source

pub async fn with_pool_size( connection_string: &str, max_size: usize, ) -> Result<Self>

Create new PostgreSQL adapter with custom pool size.

§Arguments
  • connection_string - PostgreSQL connection string
  • max_size - Maximum number of connections in pool
§Errors

Returns FraiseQLError::ConnectionPool if pool creation fails.

Source

pub fn pool(&self) -> &Pool

Get a reference to the internal connection pool.

This allows sharing the pool with other components like PostgresIntrospector.

Source

pub async fn execute_with_projection( &self, view: &str, projection: Option<&SqlProjectionHint>, where_clause: Option<&WhereClause>, limit: Option<u32>, ) -> Result<Vec<JsonbValue>>

Execute query with SQL field projection optimization.

Uses the provided SqlProjectionHint to generate optimized SQL that projects only the requested fields from the JSONB column, reducing network payload and JSON deserialization overhead.

§Arguments
  • view - View/table name to query
  • projection - Optional SQL projection hint with field list
  • where_clause - Optional WHERE clause for filtering
  • limit - Optional row limit
§Returns

Vector of projected JSONB rows with only the requested fields

§Errors

Returns FraiseQLError::Database on query execution failure.

§Example
let projection = SqlProjectionHint {
    database: "postgresql".to_string(),
    projection_template: "...".to_string(),
    estimated_reduction_percent: 75,
};

let results = adapter
    .execute_with_projection("v_user", Some(&projection), None, Some(10))
    .await?;

Trait Implementations§

Source§

impl Clone for PostgresAdapter

Source§

fn clone(&self) -> PostgresAdapter

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl DatabaseAdapter for PostgresAdapter

Source§

fn execute_with_projection<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, view: &'life1 str, projection: Option<&'life2 SqlProjectionHint>, where_clause: Option<&'life3 WhereClause>, limit: Option<u32>, ) -> Pin<Box<dyn Future<Output = Result<Vec<JsonbValue>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Execute a WHERE query with SQL field projection optimization. Read more
Source§

fn execute_where_query<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, view: &'life1 str, where_clause: Option<&'life2 WhereClause>, limit: Option<u32>, offset: Option<u32>, ) -> Pin<Box<dyn Future<Output = Result<Vec<JsonbValue>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a WHERE query against a view and return JSONB rows. Read more
Source§

fn database_type(&self) -> DatabaseType

Get database type (for logging/metrics). Read more
Source§

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Health check - verify database connectivity. Read more
Source§

fn pool_metrics(&self) -> PoolMetrics

Get connection pool metrics. Read more
Source§

fn execute_raw_query<'life0, 'life1, 'async_trait>( &'life0 self, sql: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<HashMap<String, Value>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute raw SQL query and return rows as JSON objects. Read more
Source§

fn execute_function_call<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, function_name: &'life1 str, args: &'life2 [Value], ) -> Pin<Box<dyn Future<Output = Result<Vec<HashMap<String, Value>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Execute a PostgreSQL function call and return all columns as rows. Read more
Source§

fn capabilities(&self) -> DatabaseCapabilities

Get database capabilities. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more