https://github.com/krasun/gosqlparser

Simple SQL parser
https://github.com/krasun/gosqlparser

go go-library golang lexer lexer-parser parser sql sqlparser

Last synced: about 1 month ago
JSON representation

Simple SQL parser

• Host: GitHub
• URL: https://github.com/krasun/gosqlparser
• Owner: krasun
• License: mit
• Created: 2021-11-11T16:27:25.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-09T12:39:56.000Z (about 3 years ago)
• Last Synced: 2024-12-09T17:00:35.536Z (about 2 months ago)
• Topics: go, go-library, golang, lexer, lexer-parser, parser, sql, sqlparser
• Language: Go
• Homepage:
• Size: 31.3 KB
• Stars: 67
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gosqlparser

[![Build](https://github.com/krasun/gosqlparser/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/krasun/gosqlparser/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/krasun/gosqlparser/branch/main/graph/badge.svg?token=8NU6LR4FQD)](https://codecov.io/gh/krasun/gosqlparser)

[![Go Report Card](https://goreportcard.com/badge/github.com/krasun/gosqlparser)](https://goreportcard.com/report/github.com/krasun/gosqlparser)

[![GoDoc](https://godoc.org/https://godoc.org/github.com/krasun/gosqlparser?status.svg)](https://godoc.org/github.com/krasun/gosqlparser)

`gosqlparser` is a simple SQL parser.

Use cases: 

- as part of the database engine; 

- as part of an application API instead of RPC or REST; 

- to query data from CSV and other table-like files.

## Installation

As simple as:

```

go get github.com/krasun/gosqlparser

```

## Usage 

```go

package gosqlparser_test

import (

	"fmt"

	"encoding/json"

	sql "github.com/krasun/gosqlparser"

)

func Example() {

	query, err := sql.Parse("SELECT col1, col2 FROM table1 WHERE col1 == \"abc\" AND col3 == 5 LIMIT 10")

	if err != nil {

		fmt.Printf("unexpected error: %s", err)

		return

	}

	json, err := json.Marshal(query)

	if err != nil {

		fmt.Printf("unexpected error: %s", err)

		return

	}

	fmt.Println(string(json))

	// Output:

	// {"Table":"table1","Columns":["col1","col2"],"Where":{"Expr":{"Left":{"Left":{"Name":"col1"},"Operator":0,"Right":{"Value":"\"abc\""}},"Operator":1,"Right":{"Left":{"Name":"col3"},"Operator":0,"Right":{"Value":"5"}}}},"Limit":"10"}

}

```

## Supported Statements

CREATE: 

```

CREATE TABLE table1 (c1 INTEGER, c2 STRING)

```

DROP: 

```

DROP TABLE table1

```

SELECT: 

```

SELECT c1, c2 FROM table1 WHERE c3 == c4 AND c5 == c6

```

INSERT: 

```

INSERT INTO table1 (c1, c2, c3) VALUES (5, "some string", 10)

```

UPDATE: 

```

UPDATE table1 SET c1 = 10 WHERE c1 == 5 AND c3 == "quoted string"

```

DELETE: 

```

DELETE FROM table1 WHERE c1 == 5 AND c3 == "quoted string"

```

## Tests 

To make sure that the code is fully tested and covered:

```

$ go test .

ok  	github.com/krasun/gosqlparser	0.470s

```

## Known Usages 

1. [krasun/gosqldb](https://github.com/krasun/gosqldb) - my experimental implementation of a simple database.

## License 

**gosqlparser** is released under [the MIT license](LICENSE).