base_Root_Module_ItemDefinition_PropertyDefinition_sql_text.md

@onzag/itemize / Modules / base/Root/Module/ItemDefinition/PropertyDefinition/sql/text

Module: base/Root/Module/ItemDefinition/PropertyDefinition/sql/text

Provides the sql functions for use with the text type

Table of contents

Functions

• textElastic
• textElasticIn
• textElasticSearch
• textElasticStrSearch
• textSQL
• textSQLBtreeIndexable
• textSQLIn
• textSQLOrderBy
• textSQLOut
• textSQLSearch
• textSQLSelect
• textSQLStrSearch
• textSqlRedoDictionaryIndex

Functions

textElastic

▸ textElastic(arg): Object

Parameters

Name	Type
arg	ISQLArgInfo

Returns

Object

Name	Type
properties	{}

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:49

---

textElasticIn

▸ textElasticIn(arg): Object

Parameters

Name	Type
arg	ISQLOutInfo

Returns

Object

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:347

---

textElasticSearch

▸ textElasticSearch(arg): Object

Provides the text sql search functionality

Parameters

Name	Type	Description
arg	IElasticSearchInfo	the sql search arg info

Returns

Object

a boolean on whether it was searched by it, and a complementary column order by in case it needs it

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:295

---

textElasticStrSearch

▸ textElasticStrSearch(arg): Object

Provides the text FTS str sql search functionality

Parameters

Name	Type
arg	IElasticStrSearchInfo

Returns

Object

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:398

---

textSQL

▸ textSQL(arg): Object

Provides the sql form for the text type

Parameters

Name	Type	Description
arg	ISQLArgInfo	the sql arg info

Returns

Object

a partial row definition

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:17

---

textSQLBtreeIndexable

▸ textSQLBtreeIndexable(): string[]

Provides the btree indexable function for text type

Returns

string[]

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:455

---

textSQLIn

▸ textSQLIn(arg): Object

Provides the sql in functionality for the text type

Parameters

Name	Type	Description
arg	ISQLInInfo	the sql in arg info

Returns

Object

a partial row value

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:131

---

textSQLOrderBy

▸ textSQLOrderBy(arg): [string, string, string]

Provides the order by rule form

Parameters

Name	Type	Description
arg	ISQLOrderByInfo	the sql order by arg info

Returns

[string, string, string]

the order by rule string array (or null) if not possible to order

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:441

---

textSQLOut

▸ textSQLOut(arg): IPropertyDefinitionSupportedTextType

Parameters

Name	Type
arg	ISQLOutInfo

Returns

IPropertyDefinitionSupportedTextType

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:98

---

textSQLSearch

▸ textSQLSearch(arg): boolean | [string, any[]]

Provides the text sql search functionality

Parameters

Name	Type	Description
arg	ISQLSearchInfo	the sql search arg info

Returns

boolean | [string, any[]]

a boolean on whether it was searched by it, and a complementary column order by in case it needs it

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:251

---

textSQLSelect

▸ textSQLSelect(arg): string[]

Parameters

Name	Type
arg	IArgInfo

Returns

string[]

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:42

---

textSQLStrSearch

▸ textSQLStrSearch(arg): boolean | [string, any[]]

Provides the text FTS str sql search functionality

Parameters

Name	Type	Description
arg	ISQLStrSearchInfo	the sql str search arg info

Returns

boolean | [string, any[]]

a boolean on whether it was searched by it, and a complementary column order by in case it needs it

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:370

---

textSqlRedoDictionaryIndex

▸ textSqlRedoDictionaryIndex(arg): Object

Provides the sql in functionality for redoing sql based indexes

Parameters

Name	Type	Description
arg	ISQLRedoDictionaryBasedIndex	the sql in arg info

Returns

Object

a partial row value

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/text.ts:232