Skip to main content

RdbcItemWriterBuilder

Struct RdbcItemWriterBuilder 

Source
pub struct RdbcItemWriterBuilder<'a, O> { /* private fields */ }
Available on crate feature rdbc only.
Expand description

Unified builder for creating RDBC item writers for any supported database type.

This builder provides a consistent API for constructing database writers regardless of the underlying database (PostgreSQL, MySQL, or SQLite). Users specify the database type, connection pool, table, and columns, and the builder handles the creation of the appropriate writer implementation.

§Type Parameters

  • O - The item type to write

§Examples

§PostgreSQL

use spring_batch_rs::item::rdbc::{RdbcItemWriterBuilder, DatabaseItemBinder};
use sqlx::{PgPool, query_builder::Separated, Postgres};
use serde::Serialize;

#[derive(Clone, Serialize)]
struct User {
    id: i32,
    name: String,
}

struct UserBinder;
impl DatabaseItemBinder<User, Postgres> for UserBinder {
    fn bind(&self, item: &User, mut query_builder: Separated<Postgres, &str>) {
        let _ = (item, query_builder); // Placeholder to avoid unused warnings
        // In real usage: query_builder.push_bind(item.id);
        // In real usage: query_builder.push_bind(&item.name);
    }
}

let pool = PgPool::connect("postgresql://user:pass@localhost/db").await?;
let binder = UserBinder;

let writer = RdbcItemWriterBuilder::<User>::new()
    .postgres(&pool)
    .table("users")
    .add_column("id")
    .add_column("name")
    .postgres_binder(&binder)
    .build_postgres();

§MySQL

use spring_batch_rs::item::rdbc::{RdbcItemWriterBuilder, DatabaseItemBinder};
use sqlx::{MySqlPool, query_builder::Separated, MySql};
use serde::Serialize;

#[derive(Clone, Serialize)]
struct Product {
    id: i32,
    name: String,
}

struct ProductBinder;
impl DatabaseItemBinder<Product, MySql> for ProductBinder {
    fn bind(&self, item: &Product, mut query_builder: Separated<MySql, &str>) {
        let _ = (item, query_builder); // Placeholder to avoid unused warnings
        // In real usage: query_builder.push_bind(item.id);
        // In real usage: query_builder.push_bind(&item.name);
    }
}

let pool = MySqlPool::connect("mysql://user:pass@localhost/db").await?;
let binder = ProductBinder;

let writer = RdbcItemWriterBuilder::<Product>::new()
    .mysql(&pool)
    .table("products")
    .add_column("id")
    .add_column("name")
    .mysql_binder(&binder)
    .build_mysql();

§SQLite

use spring_batch_rs::item::rdbc::{RdbcItemWriterBuilder, DatabaseItemBinder};
use sqlx::{SqlitePool, query_builder::Separated, Sqlite};
use serde::Serialize;

#[derive(Clone, Serialize)]
struct Task {
    id: i32,
    title: String,
}

struct TaskBinder;
impl DatabaseItemBinder<Task, Sqlite> for TaskBinder {
    fn bind(&self, item: &Task, mut query_builder: Separated<Sqlite, &str>) {
        let _ = (item, query_builder); // Placeholder to avoid unused warnings
        // In real usage: query_builder.push_bind(item.id);
        // In real usage: query_builder.push_bind(&item.title);
    }
}

let pool = SqlitePool::connect("sqlite::memory:").await?;
let binder = TaskBinder;

let writer = RdbcItemWriterBuilder::<Task>::new()
    .sqlite(&pool)
    .table("tasks")
    .add_column("id")
    .add_column("title")
    .sqlite_binder(&binder)
    .build_sqlite();

Implementations§

Source§

impl<'a, O> RdbcItemWriterBuilder<'a, O>

Source

pub fn new() -> Self

Creates a new unified writer builder with default configuration.

Source

pub fn postgres(self, pool: &'a Pool<Postgres>) -> Self

Sets the PostgreSQL connection pool and database type.

§Arguments
  • pool - The PostgreSQL connection pool
§Returns

The updated builder instance configured for PostgreSQL

Source

pub fn mysql(self, pool: &'a Pool<MySql>) -> Self

Sets the MySQL connection pool and database type.

§Arguments
  • pool - The MySQL connection pool
§Returns

The updated builder instance configured for MySQL

Source

pub fn sqlite(self, pool: &'a Pool<Sqlite>) -> Self

Sets the SQLite connection pool and database type.

§Arguments
  • pool - The SQLite connection pool
§Returns

The updated builder instance configured for SQLite

Source

pub fn table(self, table: &'a str) -> Self

Sets the table name for the writer.

§Arguments
  • table - The database table name
§Returns

The updated builder instance

Source

pub fn add_column(self, column: &'a str) -> Self

Adds a column to the writer.

§Arguments
  • column - The column name
§Returns

The updated builder instance

Source

pub fn postgres_binder( self, binder: &'a dyn DatabaseItemBinder<O, Postgres>, ) -> Self

Sets the item binder for PostgreSQL.

§Arguments
  • binder - The PostgreSQL-specific item binder
§Returns

The updated builder instance

Source

pub fn mysql_binder(self, binder: &'a dyn DatabaseItemBinder<O, MySql>) -> Self

Sets the item binder for MySQL.

§Arguments
  • binder - The MySQL-specific item binder
§Returns

The updated builder instance

Source

pub fn sqlite_binder( self, binder: &'a dyn DatabaseItemBinder<O, Sqlite>, ) -> Self

Sets the item binder for SQLite.

§Arguments
  • binder - The SQLite-specific item binder
§Returns

The updated builder instance

Source

pub fn build_postgres(self) -> PostgresItemWriter<'a, O>

Builds a PostgreSQL writer.

§Returns

A configured PostgresItemWriter instance

§Panics

Panics if required PostgreSQL-specific configuration is missing

Source

pub fn build_mysql(self) -> MySqlItemWriter<'a, O>

Builds a MySQL writer.

§Returns

A configured MySqlItemWriter instance

§Panics

Panics if required MySQL-specific configuration is missing

Source

pub fn build_sqlite(self) -> SqliteItemWriter<'a, O>

Builds a SQLite writer.

§Returns

A configured SqliteItemWriter instance

§Panics

Panics if required SQLite-specific configuration is missing

Trait Implementations§

Source§

impl<'a, O> Default for RdbcItemWriterBuilder<'a, O>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a, O> Freeze for RdbcItemWriterBuilder<'a, O>

§

impl<'a, O> !RefUnwindSafe for RdbcItemWriterBuilder<'a, O>

§

impl<'a, O> !Send for RdbcItemWriterBuilder<'a, O>

§

impl<'a, O> !Sync for RdbcItemWriterBuilder<'a, O>

§

impl<'a, O> Unpin for RdbcItemWriterBuilder<'a, O>

§

impl<'a, O> UnsafeUnpin for RdbcItemWriterBuilder<'a, O>

§

impl<'a, O> !UnwindSafe for RdbcItemWriterBuilder<'a, O>

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> Fake for T

Source§

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

Source§

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: RngExt + ?Sized, Self: FakeBase<U>,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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