edmiRemoteDefinePersistentAttrHashTable

EdmiError edmiRemoteDefinePersistentAttrHashTable(SdaiServerContext serverContextId,
                                                  SdaiAttr          attrId,  
                                                  SdaiOptions       options,
                                                  SdaiInteger       hashTableWidth, 
                                                  SdaiInteger       attrStringLength,
                                                  SdaiInvocationId  *edmiInvocationId);


To increase search speed in the database, it is possible to define persistent hash tables. A hash table is a persistent data structure in the database that speeds up the search for instances of one entity in one schema via the value of one attribute. The hash table is created when a data model of the specified schema is created and it is maintained during the entire lifetime of the model or until it is deleted. If there exist a data model based on the specified schema when the hash table is defined, this model do not get a hash table. In this case the model must be exported to a STEP file, deleted and recreated from the STEP file. Likewise is not an attribute hash table of data model removed if the attribute hash table definition is removed from the underlying schema of the data model.

This function defines attribute hash table connected to the specified attribute in the specified schema.

Arguments


1TypeNameComment
2SdaiServerContext  

serverContextId

Context identification, from edmiDefineServerContext

3 SdaiAttr

attrId

A numeric attributeId that uniquely identifies the attribute in the remote EDMdatabase.

4 SdaiOptions

options

See description of available options below. Options may be joined by using the bitwise OR operator. Default behaviour is that no subtypes be included in the returned entity extent.

5 SdaiInteger

hashTableWidth

Optional. In bits

6 SdaiInteger

attrStringLength

Optional. String length for FIXED_STRING_LENGTH,

7 SdaiInvocationId

*edmiInvocationId

Currently not used.

Return Value


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_EDMInterface'.

 

Options


TypeComment

DELETE_ATTR_HASH

The existing hash table of the specified attribute is deleted. No new hash table is defined.

REDEFINE_ATTR_HASH

The existing hash table of the specified attribute is deleted and a new hash table is defined.

SUBTYPES

Specifies that in addition to all instances of the type specified by the <entityId> argument, all subtype instances of the specified type should be queried as well.

FIXED_STRING_LENGTH

The argument <Attribute (fixed) string length> is taken as the fixed string length of the attribute.

UNIQUE_ATTR_VALUES

EDM checks that the attribute is unique when a new instance is stored or an attribute is modified.

Example


 

 

 

See also

Filter by label

There are no items with the selected labels at this time.

Â