Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 2.29 KB

README.md

File metadata and controls

102 lines (74 loc) · 2.29 KB

gosqlparser

Build codecov Go Report Card GoDoc

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

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 - my experimental implementation of a simple database.

License

gosqlparser is released under the MIT license.