https://github.com/joho/sqltocsv

Go package to turn arbitrary database/sql query results into CSV files as easily as possible
https://github.com/joho/sqltocsv

Last synced: 12 days ago
JSON representation

Go package to turn arbitrary database/sql query results into CSV files as easily as possible

• Host: GitHub
• URL: https://github.com/joho/sqltocsv
• Owner: joho
• License: other
• Created: 2014-05-17T04:32:15.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-04-28T21:11:05.000Z (over 3 years ago)
• Last Synced: 2024-10-14T21:05:55.222Z (about 1 month ago)
• Language: Go
• Size: 37.1 KB
• Stars: 186
• Watchers: 17
• Forks: 42
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sqltocsv [![Build Status](https://travis-ci.org/joho/sqltocsv.svg?branch=master)](https://travis-ci.org/joho/sqltocsv)

A library designed to let you easily turn any arbitrary sql.Rows result from a query into a CSV file with a minimum of fuss. Remember to handle your errors and close your rows (not demonstrated in every example).

## Usage

Importing the package

```go

import (

    "database/sql"

    _ "github.com/go-sql-driver/mysql" // or the driver of your choice

    "github.com/joho/sqltocsv"

)

```

Dumping a query to a file

```go

// we're assuming you've setup your sql.DB etc elsewhere

rows, _ := db.Query("SELECT * FROM users WHERE something=72")

err := sqltocsv.WriteFile("~/important_user_report.csv", rows)

if err != nil {

    panic(err)

}

```

Return a query as a CSV download on the world wide web

```go

http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {

    rows, err := db.Query("SELECT * FROM users WHERE something=72")

    if err != nil {

        http.Error(w, err, http.StatusInternalServerError)

        return

    }

    defer rows.Close()

    w.Header().Set("Content-type", "text/csv")

    w.Header().Set("Content-Disposition", "attachment; filename=\"report.csv\"")

    sqltocsv.Write(w, rows)

})

http.ListenAndServe(":8080", nil)

```

`Write` and `WriteFile` should do cover the common cases by the power of _Sensible Defaults™_ but if you need more flexibility you can get an instance of a `Converter` and fiddle with a few settings.

```go

rows, _ := db.Query("SELECT * FROM users WHERE something=72")

csvConverter := sqltocsv.New(rows)

csvConverter.TimeFormat = time.RFC822

csvConverter.Headers = append(rows.Columns(), "extra_column_one", "extra_column_two")

csvConverter.SetRowPreProcessor(func (columns []string) (bool, []string) {

    // exclude admins from report

    // NOTE: this is a dumb example because "where role != 'admin'" is better

    // but every now and then you need to exclude stuff because of calculations

    // that are a pain in sql and this is a contrived README

    if columns[3] == "admin" {

      return false, []string{}

    }

    extra_column_one = generateSomethingHypotheticalFromColumn(columns[2])

    extra_column_two = lookupSomeApiThingForColumn(columns[4])

    return append(columns, extra_column_one, extra_column_two)

})

csvConverter.WriteFile("~/important_user_report.csv")

```

For more details on what else you can do to the `Converter` see the [sqltocsv godocs](http://godoc.org/github.com/joho/sqltocsv)

## License

© [John Barton](https://johnbarton.co/) but under MIT (see [LICENSE](LICENSE)) except for fakedb_test.go which I lifted from the Go standard library and is under BSD and I am unsure what that means legally.