forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
92966: builtins: add to_tsvector {phrase,plain,}to_tsquery r=jordanlewis a=jordanlewis
Updates: cockroachdb#41288
Epic: CRDB-22357
Release note (sql change): add the to_tsvector, to_tsquery, phraseto_tsquery, and plainto_tsquery builtins which parse input documents into tsvectors and tsqueries respectively.
Co-authored-by: Jordan Lewis <[email protected]>- Loading branch information
Showing
9 changed files
with
459 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| // Copyright 2022 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package builtins | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/kv" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sem/builtins/builtinconstants" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sem/eval" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sem/tree" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/sem/volatility" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/types" | ||
| "github.com/cockroachdb/cockroach/pkg/util/tsearch" | ||
| ) | ||
|
|
||
| func init() { | ||
| for k, v := range tsearchBuiltins { | ||
| v.props.Category = builtinconstants.CategoryFullTextSearch | ||
| v.props.AvailableOnPublicSchema = true | ||
| registerBuiltin(k, v) | ||
| } | ||
| } | ||
|
|
||
| type tsParseGenerator struct { | ||
| input string | ||
| tokens []string | ||
| nextToken string | ||
| } | ||
|
|
||
| func (t tsParseGenerator) ResolvedType() *types.T { | ||
| return tsParseType | ||
| } | ||
|
|
||
| func (t *tsParseGenerator) Start(_ context.Context, _ *kv.Txn) error { | ||
| t.tokens = tsearch.TSParse(t.input) | ||
| return nil | ||
| } | ||
|
|
||
| func (t *tsParseGenerator) Next(_ context.Context) (bool, error) { | ||
| if len(t.tokens) == 0 { | ||
| return false, nil | ||
| } | ||
| t.nextToken, t.tokens = t.tokens[0], t.tokens[1:] | ||
| return true, nil | ||
| } | ||
|
|
||
| func (t tsParseGenerator) Values() (tree.Datums, error) { | ||
| return tree.Datums{tree.NewDInt(1), tree.NewDString(t.nextToken)}, nil | ||
| } | ||
|
|
||
| func (t tsParseGenerator) Close(_ context.Context) {} | ||
|
|
||
| var tsParseType = types.MakeLabeledTuple( | ||
| []*types.T{types.Int, types.String}, | ||
| []string{"tokid", "token"}, | ||
| ) | ||
|
|
||
| var tsearchBuiltins = map[string]builtinDefinition{ | ||
| "ts_parse": makeBuiltin(genProps(), | ||
| makeGeneratorOverload( | ||
| tree.ParamTypes{{Name: "parser_name", Typ: types.String}, {Name: "document", Typ: types.String}}, | ||
| types.MakeLabeledTuple( | ||
| []*types.T{types.Int, types.String}, | ||
| []string{"tokid", "token"}, | ||
| ), | ||
| func(_ context.Context, _ *eval.Context, args tree.Datums) (eval.ValueGenerator, error) { | ||
| parserName := string(tree.MustBeDString(args[0])) | ||
| if parserName != "default" { | ||
| return nil, pgerror.Newf(pgcode.UndefinedObject, "text search parser %q does not exist", parserName) | ||
| } | ||
| return &tsParseGenerator{input: string(tree.MustBeDString(args[1]))}, nil | ||
| }, | ||
| "ts_parse parses the given document and returns a series of records, "+ | ||
| "one for each token produced by parsing. "+ | ||
| "Each record includes a tokid showing the assigned token type and a token which is the text of the token.", | ||
| volatility.Stable, | ||
| ), | ||
| ), | ||
| // Full text search functions. | ||
| "to_tsvector": makeBuiltin( | ||
| tree.FunctionProperties{}, | ||
| tree.Overload{ | ||
| Types: tree.ParamTypes{{Name: "config", Typ: types.String}, {Name: "text", Typ: types.String}}, | ||
| ReturnType: tree.FixedReturnType(types.TSVector), | ||
| Fn: func(_ context.Context, evalCtx *eval.Context, args tree.Datums) (tree.Datum, error) { | ||
| // Parse, stem, and stopword the input. | ||
| config := string(tree.MustBeDString(args[0])) | ||
| document := string(tree.MustBeDString(args[1])) | ||
| vector, err := tsearch.DocumentToTSVector(config, document) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &tree.DTSVector{TSVector: vector}, nil | ||
| }, | ||
| Info: "Converts text to a tsvector, normalizing words according to the specified or default configuration. " + | ||
| "Position information is included in the result.", | ||
| Volatility: volatility.Immutable, | ||
| }, | ||
| ), | ||
| "to_tsquery": makeBuiltin( | ||
| tree.FunctionProperties{}, | ||
| tree.Overload{ | ||
| Types: tree.ParamTypes{{Name: "config", Typ: types.String}, {Name: "text", Typ: types.String}}, | ||
| ReturnType: tree.FixedReturnType(types.TSQuery), | ||
| Fn: func(_ context.Context, evalCtx *eval.Context, args tree.Datums) (tree.Datum, error) { | ||
| config := string(tree.MustBeDString(args[0])) | ||
| input := string(tree.MustBeDString(args[1])) | ||
| query, err := tsearch.ToTSQuery(config, input) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &tree.DTSQuery{TSQuery: query}, nil | ||
| }, | ||
| Info: "Converts the input text into a tsquery by normalizing each word in the input according to " + | ||
| "the specified or default configuration. The input must already be formatted like a tsquery, in other words, " + | ||
| "subsequent tokens must be connected by a tsquery operator (&, |, <->, !).", | ||
| Volatility: volatility.Immutable, | ||
| }, | ||
| ), | ||
| "plainto_tsquery": makeBuiltin( | ||
| tree.FunctionProperties{}, | ||
| tree.Overload{ | ||
| Types: tree.ParamTypes{{Name: "config", Typ: types.String}, {Name: "text", Typ: types.String}}, | ||
| ReturnType: tree.FixedReturnType(types.TSQuery), | ||
| Fn: func(_ context.Context, evalCtx *eval.Context, args tree.Datums) (tree.Datum, error) { | ||
| config := string(tree.MustBeDString(args[0])) | ||
| input := string(tree.MustBeDString(args[1])) | ||
| query, err := tsearch.PlainToTSQuery(config, input) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &tree.DTSQuery{TSQuery: query}, nil | ||
| }, | ||
| Info: "Converts text to a tsquery, normalizing words according to the specified or default configuration." + | ||
| " The & operator is inserted between each token in the input.", | ||
| Volatility: volatility.Immutable, | ||
| }, | ||
| ), | ||
| "phraseto_tsquery": makeBuiltin( | ||
| tree.FunctionProperties{}, | ||
| tree.Overload{ | ||
| Types: tree.ParamTypes{{Name: "config", Typ: types.String}, {Name: "text", Typ: types.String}}, | ||
| ReturnType: tree.FixedReturnType(types.TSQuery), | ||
| Fn: func(_ context.Context, evalCtx *eval.Context, args tree.Datums) (tree.Datum, error) { | ||
| config := string(tree.MustBeDString(args[0])) | ||
| input := string(tree.MustBeDString(args[1])) | ||
| query, err := tsearch.PhraseToTSQuery(config, input) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &tree.DTSQuery{TSQuery: query}, nil | ||
| }, | ||
| Info: "Converts text to a tsquery, normalizing words according to the specified or default configuration." + | ||
| " The <-> operator is inserted between each token in the input.", | ||
| Volatility: volatility.Immutable, | ||
| }, | ||
| ), | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.