From e57ee3e85963aad75bd1b784ab3d96755b91c5aa Mon Sep 17 00:00:00 2001 From: celoibarros Date: Sun, 8 Mar 2026 17:54:36 +0000 Subject: [PATCH] docs: improve README for discoverability --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 721c2cc..bf8e4f3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ -# Parquet Bulk Import for SQL Server +# Parquet to SQL Server Bulk Importer (.NET 8, Linux/Windows) -`ParquetBulkImporter` is a .NET 8 library for high-throughput imports of Parquet files into SQL Server tables. +[![CI](https://github.com/celoibarros/parquet-bulk-import-sqlserver/actions/workflows/ci.yml/badge.svg)](https://github.com/celoibarros/parquet-bulk-import-sqlserver/actions/workflows/ci.yml) + +`ParquetBulkImporter` is a .NET 8 library to import Parquet files into Microsoft SQL Server using bulk copy patterns for high-throughput ETL and data ingestion workloads. + +## Keywords + +Parquet, SQL Server, Bulk Insert, SqlBulkCopy, ETL, Data Engineering, .NET, C#, Linux, Windows. ## Features @@ -15,12 +21,12 @@ - .NET 8 SDK - Python 3.10+ (for Python tests) - SQL Server (local, container, or remote) -- ODBC Driver 18 for SQL Server (for connection string compatibility) +- ODBC Driver 18 for SQL Server ## Quick Start ```bash -git clone https://github.com//parquet-bulk-import-sqlserver.git +git clone https://github.com/celoibarros/parquet-bulk-import-sqlserver.git cd parquet-bulk-import-sqlserver dotnet build src/ParquetBulkImporter/ParquetBulkImporter.csproj -c Release ``` @@ -44,7 +50,7 @@ await importer.Execute(); ## Test Configuration -Set these environment variables for integration tests: +Set environment variables for integration tests: - `SQLSERVER_TEST_CONNECTION_STRING` - `PARQUET_TEST_FOLDER` (optional, default: `tests/resources`) @@ -70,8 +76,6 @@ python -m unittest discover -s tests/parquet_bulk_import_test -p "test_*.py" docker compose up -d ``` -The default SQL Server endpoint is `localhost,1433` with credentials defined in `docker-compose.yml`. - ## Repository Layout - `src/ParquetBulkImporter`: library source