Skip to content

DataFlex TechStack Documentation

DBP structs

DBP structs¶

Include: Use Db\DBP.pkg

DBP structs lists public structs used by this API.

Example¶

tDbReqQuery req
Move C_dbQueryMode_First to req.eMode

tDbTableField¶

Field	Type	Description
`hTable`	DbTable	hTable value.
`hField`	DbField	hField value.

tDbRelation¶

Field	Type	Description
`hRelatedTable`	DbTable	hRelatedTable value.
`aRelatedKey`	DbField[]	aRelatedKey value.
`hMainTable`	DbTable	hMainTable value.
`aForeignKey`	DbField[]	aForeignKey value.

tDbFieldValue¶

Field	Type	Description
`hField`	DbField	hField value.
`vValue`	Variant	vValue value.

tDbTableFieldValue¶

Field	Type	Description
`hTable`	DbTable	hTable value.
`hField`	DbField	hField value.
`vValue`	Variant	vValue value.

tDbFieldDefinition¶

Field	Type	Description
`sName`	String	sName value.
`eType`	Integer	eType value.
`nSize`	Number	nSize value.
`aAttributes`	tDbFieldAttribute[]	aAttributes value.

tDbTableDefinition¶

Field	Type	Description
`sName`	String	sName value.
`aFields`	tDbFieldDefinition[]	aFields value.
`aRelations`	tDbRelation[]	aRelations value.
`aAttributes`	tDbTableAttribute[]	aAttributes value.

tDbModel_EntityPair¶

Field	Type	Description
`hEntity`	Handle	hEntity value.
`hTable`	DbTable	hTable value.

tDbTableData¶

Field	Type	Description
`hTable`	DbTable	hTable value.
`rRowId`	DbRowId	rRowId value.
`vData`	Variant	vData value.

tDbConstraint¶

Field	Type	Description
`eType`	Integer	eType value.
`hTable`	DbTable	hTable value.
`hField`	DbField	hField value.
`vValue`	Variant	vValue value.

tDbOperationDetails¶

Field	Type	Description
`aConstraints`	tDbConstraint[]	aConstraints value.
`aRelations`	tDbRelation[]	aRelations value.
`hMainTable`	DbTable	hMainTable value.
`aTables`	DbTable[]	aTables value.

tDbMessage¶

Field	Type	Description
`eOperation`	Integer	eOperation value.
`hoModel`	Handle	hoModel value.
`eState`	Integer	eState value.
`iErrNr`	Integer	iErrNr value.
`sError`	String	sError value.
`aStates`	tDbOperationDetails[]	aStates value.
`request`	Variant	request value.
`response`	Variant	response value.

tDbReqCreateDb¶

Field	Type	Description
`bOverwrite`	Boolean	bOverwrite value.
`aTables`	DbTable[]	aTables value.

tDbReqExists¶

Field	Type	Description
`aTables`	DbTable[]	aTables value.

tDbResExists¶

Field	Type	Description
`aTables`	DbTable[]	aTables value.

tDbFindIndexSegment¶

Field	Type	Description
`eDirection`	Integer	eDirection value.
`hField`	DbField	hField value.
`vValue`	Variant	vValue value.

tDbFindOrderSegment¶

Field	Type	Description
`hTable`	DbTable	hTable value.
`hField`	DbField	hField value.
`eDirection`	Integer	eDirection value.

tDbReqFind¶

Field	Type	Description
`aIndex`	tDbFindIndexSegment[]	aIndex value.
`aOrder`	tDbFindOrderSegment[]	aOrder value.
`eMode`	Integer	eMode value.
`hMainTable`	DbTable	hMainTable value.
`aParents`	DbTable[]	aParents value.

tDbResFind¶

Field	Type	Description
`bFound`	Boolean	bFound value.
`aData`	tDbTableData[]	aData value.

tDbReqCreate¶

Field	Type	Description
`hMainTable`	DbTable	hMainTable value.
`vValues`	Variant	vValues value.

tDbReqUpdate¶

Field	Type	Description
`hMainTable`	DbTable	hMainTable value.
`aConstraints`	tDbConstraint[]	aConstraints value.
`bReturnRecord`	Boolean	bReturnRecord value.
`aData`	tDbFieldValue[]	aData value.

tDbResCreate¶

Field	Type	Description
`record`	tDbTableData	record value.

tDbResUpdate¶

Field	Type	Description
`iAffectedRows`	Integer	iAffectedRows value.
`record`	tDbTableData	record value.

tDbReqDelete¶

Field	Type	Description
`hMainTable`	DbTable	hMainTable value.
`aConstraints`	tDbConstraint[]	aConstraints value.
`bZeroFile`	Boolean	bZeroFile value.

tDbQueryField¶

Field	Type	Description
`bNative`	Boolean	bNative value.
`sExpression`	String	sExpression value.
`hTable`	DbTable	hTable value.
`hField`	DbField	hField value.

tDbQueryOrder¶

Field	Type	Description
`eDirection`	Integer	eDirection value.
`Field`	tDbQueryField	Field value.

tDbReqQuery¶

Field	Type	Description
`hMainTable`	DbTable	hMainTable value.
`eMode`	Integer	eMode value.
`rStartAt`	Variant	rStartAt value.
`aFields`	tDbQueryField[]	aFields value.
`aOrder`	tDbQueryOrder[]	aOrder value.

tDbResQuery¶

Field	Type	Description
`aRowIds`	DbRowId[]	aRowIds value.
`aData`	Variant[][]	aData value.

See also¶