Struct ArrowFlightSQL

pub struct ArrowFlightSQL {}

Available on crate feature arrow_flightsql only.

Module to work with [Arrow FlightSQL] inside of tests.

This module is based on the voltrondata/flight-sql docker image.

Example

use arrow_flight::{
    flight_service_client::FlightServiceClient, sql::client::FlightSqlServiceClient,
};
use futures::TryStreamExt;
use testcontainers::runners::AsyncRunner;
use testcontainers_modules::arrow_flightsql::ArrowFlightSQL;

#[tokio::test]
async fn arrow_flightsql_select_version() -> Result<(), Box<dyn std::error::Error + 'static>> {
    let image = ArrowFlightSQL::default();
    let instance = image.start().await?;
    let host = instance.get_host().await?;
    let port = instance.get_host_port_ipv4(31337).await?;
    let url = format!("http://{host}:{port}");
    let service_client = FlightServiceClient::connect(url).await?;
    let mut client = FlightSqlServiceClient::new_from_inner(service_client);
    let _ = client.handshake("flight_username", "test").await?;

    let mut statement = client
        .prepare("SELECT VERSION();".to_string(), None)
        .await?;
    let flight_info = statement.execute().await?;

    let ticket = flight_info.endpoint[0]
        .ticket
        .as_ref()
        .expect("Ticket not present")
        .clone();
    let flight_data = client.do_get(ticket).await?;
    let batches: Vec<_> = flight_data.try_collect().await?;
    let batch = batches.first().expect("batch 0 not present");
    let array = batch.columns().first().expect("column not present");
    let data = array.to_data();
    let buffers = data.buffers();
    let buffer = buffers.get(1).expect("buffer not present");
    let values = buffer.to_vec();
    let version = String::from_utf8(values)?;

    assert_eq!(version, "v1.0.0");
    Ok(())
}

Trait Implementations

impl Clone for ArrowFlightSQL

fn clone(&self) -> ArrowFlightSQL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrowFlightSQL

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ArrowFlightSQL

fn default() -> ArrowFlightSQL

Returns the “default value” for a type.

impl Image for ArrowFlightSQL

fn name(&self) -> &str

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> &str

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars( &self, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

Returns the mounts that needs to be created when a container is created.

fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer>

Returns the files to be copied into the container at startup.

fn entrypoint(&self) -> Option<&str>

Returns the entrypoint this image needs to be created with.

fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn expose_ports(&self) -> &[ContainerPort]

Returns the ports that needs to be exposed when a container is created.

fn exec_after_start( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.

fn exec_before_ready( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns commands that will be executed after the container has started, but before the Image::ready_conditions are awaited for.