gsqlsep

package module

v0.0.0-...-29574a1 Latest Latest Go to latest Published: Mar 31, 2023 License: Apache-2.0 Imports: 2 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/apstndb/gsqlsep

Links

Open Source Insights

README ¶

gsqlsep

A Go implementation of Google SQL(a.k.a. ZetaSQL) statement separator. Google SQL is the SQL dialect of Cloud Spanner, BigQuery, Apache Beam SQL ZetaSQL dialect, etc.

This is experimental and provided without warranty of any kind.

Features

Separate statements without syntax parsing.
- Query syntax changes will not break user codes.
- It is conceptually a partial implementation of the Google SQL lexical structure.
  - See: Quoted identifiers, String and bytes literals, Terminating semicolons, Comments
Strip comments to support Cloud Spanner Admin API, which doesn't support comments in DDL.
- (Experimental) Can preserve comments using SeparateInputPreserveComments, SeparateInputStringPreserveComments.
(Experimental) Alternative termination characters are customizable.
- It is possible to support spanner-cli style command terminators \G.
  - Example: SELECT 1\G

Acknowledgements

The implementation of this package is almost a fork of spanner-cli which is derived from spansql.

References

Backgrounds

Statement separators tend to be reinvented because there are no reusable implementations.

https://github.com/cloudspannerecosystem/spanner-cli/pull/34

Language Specifications

Documentation ¶

Index ¶

func SeparateInputString(input string, customTerminators ...string) []string
func SeparateInputStringPreserveComments(input string, customTerminators ...string) []string
type InputStatement
- func SeparateInput(input string, customTerminators ...string) []InputStatement
- func SeparateInputPreserveComments(input string, customTerminators ...string) []InputStatement
- func (stmt *InputStatement) StripComments() InputStatement

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SeparateInputString ¶

func SeparateInputString(input string, customTerminators ...string) []string

SeparateInputString separates input for each statement and returns []string. This function strip all comments in input. By default, input will be separated by terminating semicolons `;`. In addition, customTerminators can be passed, and they will be treated as terminating semicolons.

func SeparateInputStringPreserveComments ¶

func SeparateInputStringPreserveComments(input string, customTerminators ...string) []string

SeparateInputStringPreserveComments separates input for each statement and returns []string. This function preserve comments in input. By default, input will be separated by terminating semicolons `;`. In addition, customTerminators can be passed, and they will be treated as terminating semicolons.

Types ¶

type InputStatement ¶

type InputStatement struct {
	Statement  string
	Terminator string
}

func SeparateInput ¶

func SeparateInput(input string, customTerminators ...string) []InputStatement

SeparateInput separates input for each statement and returns []InputStatement. This function strip all comments in input. By default, input will be separated by terminating semicolons `;`. In addition, customTerminators can be passed, and they will be treated as terminating semicolons.

func SeparateInputPreserveComments ¶

func SeparateInputPreserveComments(input string, customTerminators ...string) []InputStatement

SeparateInputPreserveComments separates input for each statement and returns []InputStatement. This function preserve comments in input. By default, input will be separated by terminating semicolons `;`. In addition, customTerminators can be passed, and they will be treated as terminating semicolons.

func (*InputStatement) StripComments ¶

func (stmt *InputStatement) StripComments() InputStatement

Source Files ¶

View all Source files

separator.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL