Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Parser interface documentation #2716

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Update Parser interface documentation #2716

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions sql/parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,21 @@ import (
var GlobalParser Parser = NewMysqlParser()

type Parser interface {
// ParseSimple takes only query string and returns the parsed statement.
// ParseSimple takes a |query| and returns the parsed statement. If |query| represents a no-op statement,
// such as ";" or "-- comment", then implementations must return Vitess' ErrEmpty error.
ParseSimple(query string) (ast.Statement, error)
// Parse parses using default parser options of the ctx and returns the parsed statement
// along with the query string and remainder string if it's multiple queries.
// Parse parses |query| using the default parser options of the ctx and returns the parsed statement
// along with the query string and remainder string if it's multiple queries. If |query| represents a
// no-op statement, such as ";" or "-- comment", then implementations must return Vitess' ErrEmpty error.
Parse(ctx *Context, query string, multi bool) (ast.Statement, string, string, error)
// ParseWithOptions parses using given parser options and returns the parsed statement
// along with the query string and remainder string if it's multiple queries.
// ParseWithOptions parses |query| using the given parser |options| and specified |delimiter|. The parsed statement
// is returned, along with the query string and remainder string if |multi| has been set to true and there are
// multiple statements in |query|. If |query| represents a no-op statement, such as ";" or "-- comment", then
// implementations must return Vitess' ErrEmpty error.
ParseWithOptions(ctx context.Context, query string, delimiter rune, multi bool, options ast.ParserOptions) (ast.Statement, string, string, error)
// ParseOneWithOptions parses the first query using specified parsing returns the parsed statement along with
// the index of the start of the next query.
// the index of the start of the next query. If |query| represents a no-op statement, such as ";" or "-- comment",
// then implementations must return Vitess' ErrEmpty error.
ParseOneWithOptions(context.Context, string, ast.ParserOptions) (ast.Statement, int, error)
}

Expand Down
Loading