datafusion_table_providers/sql/arrow_sql_gen/mod.rs
1//! # Generate SQL statements from Arrow schemas
2//!
3//! This module provides a set of functions to generate SQL statements (i.e. DML) from Arrow schemas.
4//!
5//! The primary use case is for generating `CREATE TABLE`/`INSERT INTO` statements for SQL databases from Arrow schemas/values with given constraints.
6//!
7//! ## Example
8//!
9//! ### `CREATE TABLE` statement
10//! ```rust
11//! use std::sync::Arc;
12//! use datafusion::arrow::datatypes::{DataType, Field, Schema};
13//! use datafusion_table_providers::sql::arrow_sql_gen::statement::CreateTableBuilder;
14//!
15//! let schema = Arc::new(Schema::new(vec![
16//! Field::new("id", DataType::Int32, false),
17//! Field::new("name", DataType::Utf8, false),
18//! Field::new("age", DataType::Int32, false),
19//! ]));
20//!
21//! let sql = CreateTableBuilder::new(schema, "my_table").build_sqlite();
22//!
23//! assert_eq!(r#"CREATE TABLE IF NOT EXISTS "my_table" ( "id" integer NOT NULL, "name" text NOT NULL, "age" integer NOT NULL )"#, sql);
24//! ```
25//!
26//! With primary key constraints:
27//! ```rust
28//! use std::sync::Arc;
29//! use datafusion::arrow::datatypes::{DataType, Field, Schema};
30//! use datafusion_table_providers::sql::arrow_sql_gen::statement::CreateTableBuilder;
31//!
32//! let schema = Arc::new(Schema::new(vec![
33//! Field::new("id", DataType::Int32, false),
34//! Field::new("name", DataType::Utf8, false),
35//! Field::new("age", DataType::Int32, false),
36//! ]));
37//!
38//! let sql = CreateTableBuilder::new(schema, "my_table")
39//! .primary_keys(vec!["id"])
40//! .build_sqlite();
41//!
42//! assert_eq!(r#"CREATE TABLE IF NOT EXISTS "my_table" ( "id" integer NOT NULL, "name" text NOT NULL, "age" integer NOT NULL, PRIMARY KEY ("id") )"#, sql);
43//! ```
44
45pub mod arrow;
46#[cfg(feature = "mysql")]
47pub mod mysql;
48#[cfg(feature = "postgres")]
49pub mod postgres;
50#[cfg(feature = "sqlite")]
51pub mod sqlite;
52pub mod statement;