https://github.com/bujupah/bujupah-excel-datasource

Load csv/excel files data into grafana's dashboards from SFTP servers
https://github.com/bujupah/bujupah-excel-datasource

csv datasource ftp grafana plugin sftp sql xlsx

Last synced: 8 days ago
JSON representation

Load csv/excel files data into grafana's dashboards from SFTP servers

• Host: GitHub
• URL: https://github.com/bujupah/bujupah-excel-datasource
• Owner: Bujupah
• License: apache-2.0
• Created: 2023-09-06T11:24:09.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-19T12:38:26.000Z (10 months ago)
• Last Synced: 2024-11-24T19:45:11.862Z (3 months ago)
• Topics: csv, datasource, ftp, grafana, plugin, sftp, sql, xlsx
• Language: TypeScript
• Homepage: https://bujupah.github.io/bujupah-excel-datasource/
• Size: 933 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# CSV/SQL Datasource (under development)

[![CI](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/ci.yml/badge.svg)](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/ci.yml)

[![Docs](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/jekyll-gh-pages.yml/badge.svg)](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/jekyll-gh-pages.yml)

[![Latest Grafana API Compatibility Check](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/is-compatible.yml/badge.svg)](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/is-compatible.yml)

[![Release](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/release.yml/badge.svg)](https://github.com/Bujupah/bujupah-excel-datasource/actions/workflows/release.yml)



Load multiple csv/excel files data into grafana's dashboards from ftp/sftp servers.

## Overview / Introduction

### Config Editor

![Config Editor](https://github.com/Bujupah/bujupah-excel-datasource/raw/master/src/img/config_editor.png)

## Requirements

- Grafana 9.0+

- FTP or SFTP server

- [Grafana LLM app](https://github.com/grafana/grafana-llm-app) - optional

## Features

- Server Health check.

- Files health check.

- Support multiple formats such as CSV, TSV, LTSV, Fixed-Length Format, JSON and JSON Lines.

- Auto-detect supported files.

- Data joins between multiple files.

- SQL query editor in fullscreen

- SQL-like query language.

- SQL syntax highlighting.

- SQL autocomplete.

- SQL validation.

- SQL formatting.

- Support grafana variables.

- Support LLM - Text to SQL using OpenAI.

## Limitations

- Every column type is string - no type casting. (Workaround: you can use grafana transformation to make this work)

## Todo

- [x] Server Health check.

- [x] Files health check.

- [x] Support CSV.

- [ ] Support TSV.

- [ ] Support LTSV.

- [ ] Support Fixed-Length Format.

- [ ] Support JSON.

- [ ] Support JSON Lines.

- [ ] Auto-detect supported files.

- [x] Data joins between multiple files.

- [x] SQL query editor in fullscreen.

- [x] SQL-like query language.

- [x] SQL syntax highlighting.

- [x] SQL autocomplete.

- [ ] SQL validation.

- [ ] SQL formatting.

- [ ] Support grafana variables.

- [x] Support LLM - Text to SQL using OpenAI.

## Documentation

If your project has dedicated documentation available for users, provide links here. For help in following Grafana's style recommendations for technical documentation, refer to our [Writer's Toolkit](https://grafana.com/docs/writers-toolkit/).

## Contributing

Do you want folks to contribute to the plugin or provide feedback through specific means? If so, tell them how!