base_Root_Module_ItemDefinition_PropertyDefinition_sql_location.md

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

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

This file contains the sql functionality to be used with the location type

Table of contents

Functions

• locationElastic
• locationElasticOrderBy
• locationElasticSearch
• locationSQL
• locationSQLBtreeIndexable
• locationSQLElasticIn
• locationSQLEqual
• locationSQLIn
• locationSQLOrderBy
• locationSQLOut
• locationSQLSSCacheEqual
• locationSQLSearch
• locationSQLSelect

Functions

locationElastic

▸ locationElastic(arg): Object

Parameters

Name	Type
arg	IArgInfo

Returns

Object

Name	Type
properties	{}

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:59

---

locationElasticOrderBy

▸ locationElasticOrderBy(arg): Object

Provides the functionality on how to order by

Parameters

Name	Type	Description
arg	ISQLOrderByInfo	the order by rule info

Returns

Object

the order by rule string array

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:338

---

locationElasticSearch

▸ locationElasticSearch(arg): Object

Parameters

Name	Type
arg	IElasticSearchInfo

Returns

Object

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:270

---

locationSQL

▸ locationSQL(arg): Object

provides the SQL form for the location type

Parameters

Name	Type	Description
arg	ISQLArgInfo	the arg info

Returns

Object

a partial row definition

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:22

---

locationSQLBtreeIndexable

▸ locationSQLBtreeIndexable(): string[]

Provides the btree indexable functionality

Returns

string[]

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:387

---

locationSQLElasticIn

▸ locationSQLElasticIn(arg): Object

Parameters

Name	Type
arg	ISQLOutInfo

Returns

Object

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:199

---

locationSQLEqual

▸ locationSQLEqual(arg): void

Checks for equality within the database

Parameters

Name	Type	Description
arg	ISQLEqualInfo	the equal arg info

Returns

void

a partial row match

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:364

---

locationSQLIn

▸ locationSQLIn(arg): Object

Provides the functionality for sql in of data into the row

Parameters

Name	Type	Description
arg	ISQLInInfo	the sql in arg info

Returns

Object

a partial row

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:107

---

locationSQLOrderBy

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

Provides the functionality on how to order by

Parameters

Name	Type	Description
arg	ISQLOrderByInfo	the order by rule info

Returns

[string, string, string]

the order by rule string array

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:326

---

locationSQLOut

▸ locationSQLOut(arg): IPropertyDefinitionSupportedLocationType

Provides the functionality to analyze a row value and output the location type

Parameters

Name	Type	Description
arg	ISQLOutInfo	the sql out info

Returns

IPropertyDefinitionSupportedLocationType

a property definition supported location type, or null

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:176

---

locationSQLSSCacheEqual

▸ locationSQLSSCacheEqual(arg): boolean

Checks for equality within the cache

Parameters

Name	Type	Description
arg	ISQLSSCacheEqualInfo	the ss cache equal info

Returns

boolean

a boolean

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:377

---

locationSQLSearch

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

Provides the search functionality for the location type

Parameters

Name	Type	Description
arg	ISQLSearchInfo	the sql search info arg

Returns

boolean | [string, any[]]

a boolean on whether it was searched by it, or an order by rule (also when it was searched by it)

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:222

---

locationSQLSelect

▸ locationSQLSelect(arg): string[]

provides the SQL select form for the location type

Parameters

Name	Type	Description
arg	ISQLArgInfo	the arg info

Returns

string[]

Defined in

base/Root/Module/ItemDefinition/PropertyDefinition/sql/location.ts:91