DataStore

📊 Overview: 19 Functions

Extends: DataStoreImplementation

🕐 Last updated: 2025-12-10T11:45:22.587Z

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • getDuplicateValueEntities (2 params) → $DuplicateEntitySelection : 4D.EntitySelection 🖥️
    • applyFormulasToSelection (3 params) → $LockedEntityCollection : Collection 🖥️
    • lockEntitySelection (2 params) → $LockedSelectionObject : Object 🖥️
    • unlockEntitySelection (1 param) 🖥️
    • lockEntity (2 params) → $Success : Boolean 🖥️
    • getTablePrimaryKeyField (1 param) → Pointer 🖥️
    • getRelation (2 params) → $relatedEntityOrEntitySelection : Variant 🖥️
    • getRelationName (3 params) → $relationName : Text
    • updateClientFiles → Boolean
    • stringTest (1 param) → Boolean
    • echoTest (1 param) → Variant
    • blobTest (1 param) → Integer
    • _getUpdateFolder → 4D.Folder
    • updateServer (1 param) → Object
    • testA → Object
    • testB → Object
    • unpackServerUpdate → Boolean
    • _updateServer 🖥️
    • _unpackServerUpdate->$UpdateFolder → 4D.Folder 🖥️
• 🔗 Related Items

---

Functions

Regular Functions

getDuplicateValueEntities

[🖥️ local]

Function getDuplicateValueEntities($DataClass : 4D.DataClass; $DataClassAttribute : Object) -> $DuplicateEntitySelection : 4D.EntitySelection

Returns entity selection containing all entities with duplicate values for the specified attribute

Parameters:

Name	Type	Optional	Description
$DataClass	4D.DataClass	-	-
$DataClassAttribute	Object	-	-

Returns: 4D.EntitySelection

---

applyFormulasToSelection

[🖥️ local]

Function applyFormulasToSelection($EntitySelection : 4D.EntitySelection; $FormulaOrFormulaCollection : Variant; $FormulaParamsCollection : Collection) -> $LockedEntityCollection : Collection

Applies formula(s) to each entity in selection, locks entities during update, returns collection of locked entities

Parameters:

Name	Type	Optional	Description
$EntitySelection	4D.EntitySelection	-	-
$FormulaOrFormulaCollection	Variant	-	-
$FormulaParamsCollection	Collection	-	-

Returns: Collection

---

lockEntitySelection

[🖥️ local]

Function lockEntitySelection($EntitySelection : 4D.EntitySelection; $LockIfErrorOccurs : Boolean) -> $LockedSelectionObject : Object

Locks all entities in selection, returns object with locked entities collection and success status

Parameters:

Name	Type	Optional	Description
$EntitySelection	4D.EntitySelection	-	-
$LockIfErrorOccurs	Boolean	-	-

Returns: Object

---

unlockEntitySelection

[🖥️ local]

Function unlockEntitySelection($LockedSelectionObject : Object)

Unlocks all entities in the locked selection object’s collection

Parameters:

Name	Type	Optional	Description
$LockedSelectionObject	Object	-	-

---

lockEntity

[🖥️ local]

Function lockEntity($Entity : 4D.Entity; $DisplayWarning : Boolean) -> $Success : Boolean

Locks a single entity with reload if stamp changed, optionally displays warning dialog on failure

Parameters:

Name	Type	Optional	Description
$Entity	4D.Entity	-	-
$DisplayWarning	Boolean	-	-

Returns: Boolean

---

getTablePrimaryKeyField

[🖥️ local]

Function getTablePrimaryKeyField($TablePointerOrNumber : Variant) -> Pointer

Returns a pointer to the primary key field of the specified table (accepts pointer or table number)

Parameters:

Name	Type	Optional	Description
$TablePointerOrNumber	Variant	-	-

Returns: Pointer

---

getRelation

[🖥️ local]

Function getRelation($entityOrEntitySelection : Variant; $destinationTable : 4D.DataClass) -> $relatedEntityOrEntitySelection : Variant

Returns related entity or entity selection from source to destination table via ORDA relationship

Parameters:

Name	Type	Optional	Description
$entityOrEntitySelection	Variant	-	-
$destinationTable	4D.DataClass	-	-

Returns: Variant

---

getRelationName

Function getRelationName($sourceTableClass : 4D.Class; $destinationTableClass : 4D.Class; $supressNoRelationWarning : Boolean) -> $relationName : Text

Returns the attribute name representing the relationship between source and destination tables

Parameters:

Name	Type	Optional	Description
$sourceTableClass	4D.Class	-	-
$destinationTableClass	4D.Class	-	-
$supressNoRelationWarning	Boolean	-	-

Returns: Text

---

updateClientFiles

Function updateClientFiles -> Boolean

Returns: Boolean

---

stringTest

Function stringTest($Text : Text) -> Boolean

Parameters:

Name	Type	Optional	Description
$Text	Text	-	-

Returns: Boolean

---

echoTest

Function echoTest($Variant : Variant) -> Variant

Parameters:

Name	Type	Optional	Description
$Variant	Variant	-	-

Returns: Variant

---

blobTest

Function blobTest($Blob : Blob) -> Integer

Parameters:

Name	Type	Optional	Description
$Blob	Blob	-	-

Returns: Integer

---

_getUpdateFolder

Function _getUpdateFolder -> 4D.Folder

Returns: 4D.Folder

---

updateServer

Function updateServer($RestartServer : Boolean) -> Object

Parameters:

Name	Type	Optional	Description
$RestartServer	Boolean	-	-

Returns: Object

---

testA

Function testA -> Object

Returns: Object

---

testB

Function testB -> Object

Returns: Object

---

unpackServerUpdate

Function unpackServerUpdate -> Boolean

Returns: Boolean

---

_updateServer

[🖥️ local]

Function _updateServer

---

_unpackServerUpdate->$UpdateFolder {#_unpackserverupdate->$updatefolder}

[🖥️ local]

Function _unpackServerUpdate->$UpdateFolder -> 4D.Folder

Returns: 4D.Folder

---

Related Items

� Related Classes

• DataStoreImplementation - Base class for DataStore X

---

Generated from DataStore.4dm