Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fugerit-org/query-export-tool

Tool export query in CSV and XLS / XLSX format
https://github.com/fugerit-org/query-export-tool

csv export query tool xls xlsx

Last synced: 2 months ago
JSON representation

Tool export query in CSV and XLS / XLSX format

Host: GitHub
URL: https://github.com/fugerit-org/query-export-tool
Owner: fugerit-org
License: apache-2.0
Created: 2019-06-08T09:29:18.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-11-05T08:03:12.000Z (2 months ago)
Last Synced: 2024-11-05T09:18:18.655Z (2 months ago)
Topics: csv, export, query, tool, xls, xlsx
Language: Java
Homepage:
Size: 114 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # query-export-tool

Tool export query in CSV and XLS / XLSX format

[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 

[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/query-export-tool.svg)](https://mvnrepository.com/artifact/org.fugerit.java/query-export-tool)

[![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0)

[![code of conduct](https://img.shields.io/badge/conduct-Contributor%20Covenant-purple.svg)](https://github.com/fugerit-org/fj-universe/blob/main/CODE_OF_CONDUCT.md)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_query-export-tool&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_query-export-tool)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_query-export-tool&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_query-export-tool)

![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge&logo=openjdk&logoColor=white)

![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)

![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)

## 1 Quickstart

### 1.1 Create a sample query catalog 

```

	

		

		

		

		

		

	

```

### 1.2 Load and use the catalog

```

		QueryConfigCatalog catalog = QueryConfigCatalog.loadQueryConfigCatalogSafe( "cl://sample/query-catalog-sample.xml" );

		try ( Connection conn = ... ) {

			catalog.handle( conn , "main-catalog", "Q001");

		}

```

## 2 Formats

### 2.1 HTML format

HTML format is handled with core I/O API, no dependency needed.

### 2.2 CSV format

CSV Format needs *OpenCSV* dependency, which is automatically included by default when importing query-export-tool dependency.

If needed it can be added in explicit way : 

```

		

			com.opencsv

			opencsv

			${opencsv-version}

		

```

### 2.3 XLS/XLSX formats

XLS/XLSX Formats needs *Apache POI* dependency, which is *NOT* automatically included by default when importing query-export-tool dependency : 

```

		

			org.apache.poi

			poi-ooxml

			${poi-version}

		

```

## 3 Usage As SQL Catalog

Create the xml catalog : 

```xml

	

		

			SELECT * FROM  test_export

		

	

```

Access the catalog : 

```java

QueryConfigCatalog catalog = QueryConfigCatalog.loadQueryConfigCatalogSafe("cl://sample/query-catalog-sample-alt.xml");

QueryConfig queryConfig = catalog.getListMap( "sample-catalog-alt" ).get( "Q001ALT" );

logger.info( "query config : {}, sql : {}", queryConfig, queryConfig.getSql() );

```

A full example is available in the [JUNIT](src/test/java/test/org/fugerit/java/query/export/tool/TestCatalogAlt.java) .