axum-sql-viewer 0.1.5

A development tool for viewing SQL tables in web browsers, easily integrable as an Axum layer
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
//! PostgreSQL database provider implementation

use crate::database::traits::{DatabaseError, DatabaseProvider};
use crate::schema::{
    ColumnInfo, CountResponse, ForeignKey, IndexInfo, QueryResult, RowQuery, RowsResponse,
    SortOrder, TableInfo, TableSchema,
};
use async_trait::async_trait;
use sqlx::{postgres::PgRow, Column, PgPool, Row, TypeInfo};
use std::collections::HashMap;

/// PostgreSQL database provider
pub struct PostgresProvider {
    pool: PgPool,
}

impl PostgresProvider {
    /// Create a new PostgreSQL provider
    ///
    /// # Arguments
    ///
    /// * `pool` - PostgreSQL connection pool
    pub fn new(pool: PgPool) -> Self {
        Self { pool }
    }

    /// Quote an identifier to prevent SQL injection
    fn quote_identifier(identifier: &str) -> String {
        format!("\"{}\"", identifier.replace("\"", "\"\""))
    }

    /// Convert a PostgreSQL row to a JSON object
    fn row_to_json(row: &PgRow) -> Result<serde_json::Value, DatabaseError> {
        let mut map = serde_json::Map::new();

        for column in row.columns() {
            let column_name = column.name();
            let type_info = column.type_info();
            let type_name = type_info.name();

            let value: serde_json::Value = match type_name {
                "BOOL" => {
                    let val: Option<bool> = row.try_get(column_name)?;
                    val.map(serde_json::Value::Bool).unwrap_or(serde_json::Value::Null)
                }
                "INT2" | "SMALLINT" | "SMALLSERIAL" => {
                    let val: Option<i16> = row.try_get(column_name)?;
                    val.map(|v| serde_json::Value::Number(v.into())).unwrap_or(serde_json::Value::Null)
                }
                "INT4" | "INT" | "INTEGER" | "SERIAL" => {
                    let val: Option<i32> = row.try_get(column_name)?;
                    val.map(|v| serde_json::Value::Number(v.into())).unwrap_or(serde_json::Value::Null)
                }
                "INT8" | "BIGINT" | "BIGSERIAL" => {
                    let val: Option<i64> = row.try_get(column_name)?;
                    val.map(|v| serde_json::Value::Number(v.into())).unwrap_or(serde_json::Value::Null)
                }
                "FLOAT4" | "REAL" => {
                    let val: Option<f32> = row.try_get(column_name)?;
                    val.and_then(|v| serde_json::Number::from_f64(v as f64))
                        .map(serde_json::Value::Number)
                        .unwrap_or(serde_json::Value::Null)
                }
                "FLOAT8" | "DOUBLE PRECISION" => {
                    let val: Option<f64> = row.try_get(column_name)?;
                    val.and_then(serde_json::Number::from_f64)
                        .map(serde_json::Value::Number)
                        .unwrap_or(serde_json::Value::Null)
                }
                "TEXT" | "VARCHAR" | "CHAR" | "NAME" | "BPCHAR" => {
                    let val: Option<String> = row.try_get(column_name)?;
                    val.map(serde_json::Value::String).unwrap_or(serde_json::Value::Null)
                }
                "BYTEA" => {
                    let val: Option<Vec<u8>> = row.try_get(column_name)?;
                    val.map(|bytes| {
                        serde_json::Value::String(format!("[BLOB: {} bytes]", bytes.len()))
                    }).unwrap_or(serde_json::Value::Null)
                }
                "TIMESTAMP" | "TIMESTAMPTZ" | "TIMESTAMP WITHOUT TIME ZONE" | "TIMESTAMP WITH TIME ZONE"
                | "DATE" | "TIME" | "TIME WITHOUT TIME ZONE" => {
                    // Try to get as string representation
                    let val: Option<String> = row.try_get(column_name).ok().flatten();
                    val.map(serde_json::Value::String)
                        .unwrap_or(serde_json::Value::Null)
                }
                "JSON" | "JSONB" => {
                    let val: Option<serde_json::Value> = row.try_get(column_name)?;
                    val.unwrap_or(serde_json::Value::Null)
                }
                "UUID" => {
                    // Try to get as string representation
                    let val: Option<String> = row.try_get(column_name).ok().flatten();
                    val.map(serde_json::Value::String)
                        .unwrap_or(serde_json::Value::Null)
                }
                "NUMERIC" | "DECIMAL" => {
                    // Try to get as string to preserve precision
                    let val: Option<String> = row.try_get(column_name).ok().flatten();
                    val.map(serde_json::Value::String)
                        .unwrap_or(serde_json::Value::Null)
                }
                _ => {
                    // Fallback: try to get as string
                    let val: Option<String> = row.try_get(column_name).ok().flatten();
                    val.map(serde_json::Value::String).unwrap_or(serde_json::Value::Null)
                }
            };

            map.insert(column_name.to_string(), value);
        }

        Ok(serde_json::Value::Object(map))
    }

    /// Build a WHERE clause from filters
    fn build_where_clause(filters: &HashMap<String, String>, parameter_offset: i32) -> (String, Vec<String>) {
        if filters.is_empty() {
            return (String::new(), vec![]);
        }

        let mut conditions = Vec::new();
        let mut values = Vec::new();
        let mut param_index = parameter_offset;

        for (column, filter_value) in filters {
            let quoted_column = Self::quote_identifier(column);

            if filter_value.contains('%') {
                conditions.push(format!("{} LIKE ${}", quoted_column, param_index));
            } else {
                conditions.push(format!("{} = ${}", quoted_column, param_index));
            }

            values.push(filter_value.clone());
            param_index += 1;
        }

        let where_clause = format!(" WHERE {}", conditions.join(" AND "));
        (where_clause, values)
    }
}

#[async_trait]
impl DatabaseProvider for PostgresProvider {
    async fn list_tables(&self) -> Result<Vec<TableInfo>, DatabaseError> {
        let query = r#"
            SELECT table_name
            FROM information_schema.tables
            WHERE table_schema = 'public'
              AND table_type = 'BASE TABLE'
            ORDER BY table_name
        "#;

        let rows = sqlx::query(query)
            .fetch_all(&self.pool)
            .await?;

        let mut tables = Vec::new();
        for row in rows {
            let name: String = row.try_get("table_name")?;

            // Get row count for each table
            let count_query = format!(
                "SELECT COUNT(*) as count FROM {}",
                Self::quote_identifier(&name)
            );
            let row_count: Option<u64> = sqlx::query_scalar(&count_query)
                .fetch_one(&self.pool)
                .await
                .ok()
                .map(|count: i64| count as u64);

            tables.push(TableInfo { name, row_count });
        }

        Ok(tables)
    }

    async fn get_table_schema(&self, table: &str) -> Result<TableSchema, DatabaseError> {
        // Get column information
        let column_query = r#"
            SELECT
                column_name,
                data_type,
                is_nullable,
                column_default,
                udt_name
            FROM information_schema.columns
            WHERE table_schema = 'public'
              AND table_name = $1
            ORDER BY ordinal_position
        "#;

        let column_rows = sqlx::query(column_query)
            .bind(table)
            .fetch_all(&self.pool)
            .await?;

        if column_rows.is_empty() {
            return Err(DatabaseError::TableNotFound(table.to_string()));
        }

        // Get primary key columns
        let pk_query = r#"
            SELECT kcu.column_name
            FROM information_schema.table_constraints tc
            JOIN information_schema.key_column_usage kcu
              ON tc.constraint_name = kcu.constraint_name
              AND tc.table_schema = kcu.table_schema
            WHERE tc.table_schema = 'public'
              AND tc.table_name = $1
              AND tc.constraint_type = 'PRIMARY KEY'
            ORDER BY kcu.ordinal_position
        "#;

        let pk_rows = sqlx::query(pk_query)
            .bind(table)
            .fetch_all(&self.pool)
            .await?;

        let primary_key_columns: Vec<String> = pk_rows
            .iter()
            .map(|row| row.try_get::<String, _>("column_name"))
            .collect::<Result<Vec<_>, _>>()?;

        let primary_key = if primary_key_columns.is_empty() {
            None
        } else {
            Some(primary_key_columns.clone())
        };

        // Get foreign keys
        let fk_query = r#"
            SELECT
                kcu.column_name,
                ccu.table_name AS references_table,
                ccu.column_name AS references_column
            FROM information_schema.table_constraints tc
            JOIN information_schema.key_column_usage kcu
              ON tc.constraint_name = kcu.constraint_name
              AND tc.table_schema = kcu.table_schema
            JOIN information_schema.constraint_column_usage ccu
              ON ccu.constraint_name = tc.constraint_name
              AND ccu.table_schema = tc.table_schema
            WHERE tc.table_schema = 'public'
              AND tc.table_name = $1
              AND tc.constraint_type = 'FOREIGN KEY'
        "#;

        let fk_rows = sqlx::query(fk_query)
            .bind(table)
            .fetch_all(&self.pool)
            .await?;

        let foreign_keys: Vec<ForeignKey> = fk_rows
            .iter()
            .map(|row| {
                Ok(ForeignKey {
                    column: row.try_get("column_name")?,
                    references_table: row.try_get("references_table")?,
                    references_column: row.try_get("references_column")?,
                })
            })
            .collect::<Result<Vec<_>, sqlx::Error>>()?;

        // Get indexes
        let index_query = r#"
            SELECT
                i.indexname AS index_name,
                i.indexdef AS index_definition
            FROM pg_indexes i
            WHERE i.schemaname = 'public'
              AND i.tablename = $1
              AND i.indexname NOT IN (
                SELECT constraint_name
                FROM information_schema.table_constraints
                WHERE table_schema = 'public'
                  AND table_name = $1
                  AND constraint_type = 'PRIMARY KEY'
              )
        "#;

        let index_rows = sqlx::query(index_query)
            .bind(table)
            .fetch_all(&self.pool)
            .await?;

        let indexes: Vec<IndexInfo> = index_rows
            .iter()
            .map(|row| {
                let index_name: String = row.try_get("index_name")?;
                let index_definition: String = row.try_get("index_definition")?;

                // Parse column names from index definition (simplified)
                // This is a basic implementation - could be enhanced
                let columns = vec![]; // Would need proper parsing of index_definition

                let unique = index_definition.to_uppercase().contains("UNIQUE");

                Ok(IndexInfo {
                    name: index_name,
                    columns,
                    unique,
                })
            })
            .collect::<Result<Vec<_>, sqlx::Error>>()?;

        // Build column info
        let columns: Vec<ColumnInfo> = column_rows
            .iter()
            .map(|row| {
                let column_name: String = row.try_get("column_name")?;
                let data_type: String = row.try_get("data_type")?;
                let is_nullable: String = row.try_get("is_nullable")?;
                let column_default: Option<String> = row.try_get("column_default")?;

                Ok(ColumnInfo {
                    name: column_name.clone(),
                    data_type,
                    nullable: is_nullable == "YES",
                    default_value: column_default,
                    is_primary_key: primary_key_columns.contains(&column_name),
                })
            })
            .collect::<Result<Vec<_>, sqlx::Error>>()?;

        Ok(TableSchema {
            name: table.to_string(),
            columns,
            primary_key,
            foreign_keys,
            indexes,
        })
    }

    async fn get_rows(&self, table: &str, query: RowQuery) -> Result<RowsResponse, DatabaseError> {
        // Validate table exists and get columns
        let schema = self.get_table_schema(table).await?;
        let column_names: Vec<String> = schema.columns.iter().map(|c| c.name.clone()).collect();

        // Build base query
        let quoted_table = Self::quote_identifier(table);
        let mut sql = format!("SELECT * FROM {}", quoted_table);

        // Add WHERE clause for filters
        let (where_clause, filter_values) = Self::build_where_clause(&query.filters, 1);
        sql.push_str(&where_clause);

        // Add ORDER BY clause
        if let Some(sort_column) = &query.sort_by {
            // Validate sort column exists
            if !column_names.contains(sort_column) {
                return Err(DatabaseError::InvalidColumn(sort_column.clone()));
            }

            let quoted_sort = Self::quote_identifier(sort_column);
            let sort_direction = match query.sort_order {
                Some(SortOrder::Descending) => "DESC",
                _ => "ASC",
            };
            sql.push_str(&format!(" ORDER BY {} {}", quoted_sort, sort_direction));
        }

        // Add LIMIT and OFFSET
        let limit = query.limit.min(500); // Cap at 500 as per spec
        sql.push_str(&format!(" LIMIT {} OFFSET {}", limit, query.offset));

        // Execute query
        let mut query_builder = sqlx::query(&sql);
        for value in &filter_values {
            query_builder = query_builder.bind(value);
        }

        let rows = query_builder.fetch_all(&self.pool).await?;

        // Convert rows to JSON
        let json_rows: Vec<serde_json::Value> = rows
            .iter()
            .map(Self::row_to_json)
            .collect::<Result<Vec<_>, _>>()?;

        // Get total count
        let count_result = self.count_rows(table, &query).await?;
        let total = count_result.count;

        let has_more = query.offset + (json_rows.len() as u64) < total;

        Ok(RowsResponse {
            rows: json_rows,
            columns: column_names,
            total,
            offset: query.offset,
            limit,
            has_more,
        })
    }

    async fn count_rows(&self, table: &str, query: &RowQuery) -> Result<CountResponse, DatabaseError> {
        let quoted_table = Self::quote_identifier(table);
        let mut sql = format!("SELECT COUNT(*) as count FROM {}", quoted_table);

        // Add WHERE clause for filters
        let (where_clause, filter_values) = Self::build_where_clause(&query.filters, 1);
        sql.push_str(&where_clause);

        // Execute query
        let mut query_builder = sqlx::query(&sql);
        for value in &filter_values {
            query_builder = query_builder.bind(value);
        }

        let row = query_builder.fetch_one(&self.pool).await?;
        let count: i64 = row.try_get("count")?;

        Ok(CountResponse {
            count: count as u64,
        })
    }

    async fn execute_query(&self, sql: &str) -> Result<QueryResult, DatabaseError> {
        let start_time = std::time::Instant::now();

        // Try to execute as a query that returns rows (SELECT)
        let result = sqlx::query(sql).fetch_all(&self.pool).await;

        let execution_time_milliseconds = start_time.elapsed().as_millis() as u64;

        match result {
            Ok(rows) => {
                if rows.is_empty() {
                    // Could be a DML query (INSERT/UPDATE/DELETE) or SELECT with no results
                    // Try to get affected rows count
                    Ok(QueryResult {
                        columns: vec![],
                        rows: vec![],
                        affected_rows: 0,
                        execution_time_milliseconds,
                        error: None,
                    })
                } else {
                    // SELECT query with results
                    let columns: Vec<String> = rows[0]
                        .columns()
                        .iter()
                        .map(|col| col.name().to_string())
                        .collect();

                    let json_rows: Vec<serde_json::Value> = rows
                        .iter()
                        .map(Self::row_to_json)
                        .collect::<Result<Vec<_>, _>>()?;

                    // Apply row limit
                    let max_rows = 10000;
                    if json_rows.len() > max_rows {
                        return Err(DatabaseError::TooManyRows(max_rows as u64));
                    }

                    Ok(QueryResult {
                        columns,
                        rows: json_rows,
                        affected_rows: 0,
                        execution_time_milliseconds,
                        error: None,
                    })
                }
            }
            Err(error) => {
                // Return error in result
                Ok(QueryResult {
                    columns: vec![],
                    rows: vec![],
                    affected_rows: 0,
                    execution_time_milliseconds,
                    error: Some(error.to_string()),
                })
            }
        }
    }
}