Adding `datafusion_flight_sql_server` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add datafusion-flight-sql-server

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

datafusion-flight-sql-server = "0.4.16"

The datafusion_flight_sql_server library will be automatically available globally. Read the datafusion_flight_sql_server library documentation.

Back to the crate overview.

Readme

DataFusion Flight SQL Server

The datafusion-flight-sql-server is a Flight SQL server that implements the necessary endpoints to use DataFusion as the query engine.

Getting Started

To use datafusion-flight-sql-server in your Rust project, run:

$ cargo add datafusion-flight-sql-server

Example

Here's a basic example of setting up a Flight SQL server:

use datafusion_flight_sql_server::service::FlightSqlService;
use datafusion::{
    execution::{
        context::SessionContext,
        options::CsvReadOptions,
    },
};

async {
    let dsn: String = "0.0.0.0:50051".to_string();
    let remote_ctx = SessionContext::new();
    remote_ctx
        .register_csv("test", "./examples/test.csv", CsvReadOptions::new())
        .await.expect("Register csv");

    FlightSqlService::new(remote_ctx.state()).serve(dsn.clone())
        .await
        .expect("Run flight sql service");

};

This example sets up a Flight SQL server listening on 127.0.0.1:50051.

Docs

Docs link.

Acknowledgments

This repository was a Rust crate that was first built as a part of datafusion-federation repository.

Adding datafusion_flight_sql_server library as a dependency

Adding `datafusion_flight_sql_server` library as a dependency