package
1.6.28
Repository: https://github.com/softwareag/adabas-go-api.git
Documentation: pkg.go.dev

# Functions

CreateDefinitionByCache create definition out of cache if available.
CreateDynamicInterface constructor create dynamic interface.
EvaluateFieldType evaluate field type of format string.
FinitDefinitionCache finit definition cache.
FormatByteBuffer formats the byte array to an output with a hexadecimal part, a ASCII part and a EBCDIC converted part of the same data.
FormatBytes formats a given byte array and modulo space operator.
InitDefinitionCache init definition cache.
Language current message language.
LogMultiLineString log multi line string to log.
NewBufferOption create option to parse the buffer.
NewBufferOption3 create option to parse the buffer.
NewCollationType creates new collation type instance.
NewDefinition create new Definition instance.
NewDefinitionClone clone new Definition instance using old definition and clone the active tree to the new one.
NewDefinitionWithTypes create new Definition instance adding the given types into the tree.
NewDynamicHelper create a new buffer helper instance.
NewEmptyRange create an empty range.
NewFieldCondition creates a new field condition.
NewGenericError create a genernic non Adabas response error.
NewHelper create a new buffer helper instance.
NewHyperExitType new hyper exit type.
NewLastRange range defining only the last entry.
NewLongNameStructureList Creates a new object of structured list types.
NewLongNameType Define new type with length equal 1.
NewLongNameTypeWithLength Define new type.
NewPartialRange new partial range.
NewPhoneticType new phonetic descriptor type.
NewPlatform create a new platform instance.
NewPlatformIsl create a new platform instance.
NewRange new range from a dimension to a dimension.
NewRangeParser new range using string parser.
NewRedefinitionType Creates a new object of redefootopm types.
NewReferentialType new referential integrity type.
NewSearchInfo new search info base to create search tree.
NewSingleRange new single dimensioned range.
NewStack creates a new stack instance.
NewStructure Creates a new object of structured list types.
NewStructureCondition Creates a new object of structured list types.
NewStructureEmpty Creates a new object of structured list types.
NewStructureList Creates a new object of structured list types.
NewSuperType new super or sub descriptor field type.
NewTraverserMethods new traverser methods structure.
NewType Define new type with length equal 1.
NewTypeWithFlag Define new type with flag.
NewTypeWithLength Definen new type.
NewUnicodeConverter new unicode converter.
SetValueData dependent to the struct interface field the corresponding reflection struct the value will be set with the struct value.
TimeTrack defer function measure the difference end log it to log management, like defer TimeTrack(time.Now(), "CallAdabas "+string(adabas.Acbx.Acbxcmd[:])).
Translate translates content to target language.

# Constants

AdaNormal Adabas success response code.
AND AND logic.
BufferOverflow error indicates the read after the buffer maximal position.
ConstantIndicator constant indicator is replaced with constants.
Continue continue traversing the tree.
DefaultMultifetchLimit default number of multifetch entries.
EMPTY Empty (not needed).
EndTraverser end the traverser.
EQ Equals value comparisons.
FieldOptionColExit field option for collation exit.
FieldOptionDE field option for descriptors.
FieldOptionFI field option for fixed size.
FieldOptionHE field option for.
FieldOptionHF field option for high order fields.
FieldOptionLA field option for large alpha.
FieldOptionLB field option for large objects.
FieldOptionMU field option for multiple fields.
FieldOptionNB field option for.
FieldOptionNC field option for sql.
FieldOptionNN field option for non null.
FieldOptionNU field option for null suppression.
FieldOptionNV field option for null value.
FieldOptionPE field option for period.
FieldOptionPF field option for Packed F.
FieldOptionUQ field option for unique descriptors.
FieldTypeByte field type signed byte.
FieldTypeByteArray field type byte array.
FieldTypeCharacter field type character.
FieldTypeCollation field type of collation descriptors.
FieldTypeDouble field type double.
FieldTypeFieldCount field type to defined field count of MU or PE fields.
FieldTypeFieldLength field length.
FieldTypeFiller field type for fill gaps between struct types.
FieldTypeFloat field type float.
FieldTypeFunction field type to define functions working on result list.
FieldTypeGroup field type group.
FieldTypeHyperDesc field type of Hyper descriptors.
FieldTypeInt2 field type signed integer of 2 bytes.
FieldTypeInt4 field type signed integer of 4 bytes.
FieldTypeInt8 field type signed integer of 8 bytes.
FieldTypeLAString field type string large objects.
FieldTypeLAUnicode field type unicode large objects.
FieldTypeLBString field type string LOB.
FieldTypeLBUnicode field type unicode LOB.
FieldTypeLength field type for length definitions.
FieldTypeLiteral field type of literal data send to database.
FieldTypeLong field type signed long.
FieldTypeMultiplefield field type multiple fields.
FieldTypePacked field type packed.
FieldTypePackedArray field type packed array.
FieldTypePeriodGroup field type period group.
FieldTypePhonetic field type of phonetic descriptor.
FieldTypeRedefinition field type group.
FieldTypeReferential field type for referential integrity.
FieldTypeShort field type signed short.
FieldTypeString field type string.
FieldTypeStructure field type of structured types.
FieldTypeSuperDesc field type of super descriptors.
FieldTypeUByte field type unsigned byte.
FieldTypeUInt2 field type unsigned integer of 2 bytes.
FieldTypeUInt4 field type unsigned integer of 4 bytes.
FieldTypeUInt4Array field type array unsigned integer of 4 bytes.
FieldTypeUInt8 field type unsigned integer of 8 bytes.
FieldTypeUndefined field type undefined.
FieldTypeUnicode field type unicode string.
FieldTypeUnpacked field type unpacked.
FlagOptionAtomicFB indicate tree contains MU fields.
FlagOptionLengthNotIncluded length not include in record buffer.
FlagOptionLengthPE instead of length use period group count.
FlagOptionMUGhost ghost field for MU.
FlagOptionPart structure is request only in parts.
FlagOptionPE indicate tree is part of period group.
FlagOptionReadOnly read only field.
FlagOptionReference Field will skip parsing value.
FlagOptionSecondCall Field will need a second call to get the value.
FlagOptionSingleIndex single index query.
FlagOptionToBeRemoved should be removed.
GE Greater equal comparisons.
GT Greater than comparisons.
HoldAccess check during read that the record is not in hold (shared lock 'C').
HoldNone no hold.
HoldRead use shared lock until next read operation (shared lock 'Q').
HoldResponse receive response code if record is in hold state.
HoldTransaction use shared lock until end of transaction (shared lock 'S').
HoldWait wait for hold released.
LastEntry last N name index for Adabas.
LE Less equal comparisons.
LT Less than comparisons.
MOR Adabas OR logic with same descriptor.
NE Not equal comparison.
NONE No comparison (Not needed).
NoneSecond No second call.
NoReferenceField field out of range of given field possibilities.
NOT NOT logic.
OccByte Occurrence identifier indicating that the occurrence is defined as byte.
OccCapacity Occurrence identifier indicating that the occurrence capactity of 2 or PE fields.
OccNone Occurrence identifier indicating that the occurrence is not used.
OccSingle Occurrence identifier indicating that the occurrence single.
OccUInt2 Occurrence identifier indicating that the occurrence is defined as uint32.
OR Adabas OR logic.
PartialLobSize partial lob read size of first read.
PartialStoreLobSizeChunks chunk size storing lobs.
PlatformLUWHighOrder LUW high order architecture byte.
PlatformLUWLowOrder LUW low order architecture byte.
PlatformMainframe Mainframe architecture byte.
RANGE Range for a value.
ReadSecond Read call for second.
SkipStructure skip all other elements of an structure.
SkipTree skip tree of the structure value.
StoreSecond Write call for second.

# Variables

Central central configuration.
Version version of current build.

# Structs

AdabasRequestParameter Adabas request parameter defining type of Adabas request.
AdaCollationType data type structure for field types, no structures.
AdaHyperExitType data type structure for field types, no structures.
AdaPhoneticType data type phonetic descriptor for field types, no structures.
AdaRange Adabas range definition.
AdaReferentialType data type structure for referential integrity types, no structures.
AdaSuperType data type structure for super or sub descriptor field types, no structures.
AdaType data type structure for field types, no structures.
BufferHelper buffer helper structure used to parse the buffer.
BufferOption option for buffer parsing.
CommonType common data type structure defined for all types.
Definition struct defines main entry point for parser structure.
DynamicInterface dynamic interface.
Error error message with code and time.
FieldCondition field condition reference using for parser length management.
Platform platform definition structure.
RedefinitionType creates a new redefinition type.
RedefinitionValue redefinition value struct.
Request contains all relevant buffer and parameters for a Adabas call.
SearchInfo structure containing search parameters.
SearchNode node entry in the searchtree.
SearchTree tree entry point.
SearchValue value endpoint.
Stack stack creates structure.
StructureType creates a new structure type.
StructureValue structure value struct.
TraverserMethods structure for Traverser types.
TraverserValuesMethods structure for Traverser values.
UnicodeConverter unicode converter.

# Interfaces

ConvertUnicode unicode converter interface - Decode to decode byte array from unicode - Encode to encode byte array to unicode.
IAdaCallInterface caller interface.
IAdaType data type interface defined for all types.
IAdaValue defines standard interface for all values.
ILob LOB extended parameters.
ISearchNode interface for adding search tree or nodes into tree.
Log defines the log interface to manage other Log output frameworks.
PartialValue partial value definition.
StructureTraverser structure traverser interface.
StructureValueTraverser structure value traverser.

# Type aliases

ElementTraverser prepare start of an element.
FieldOption type for field option.
FieldType indicate a field type of the field.
FlagOption flag option used to omit traversal through the tree (example is MU and PE).
HoldType hold enum type.
Isn Adabas Internal ISN.
PrepareTraverser prepare giving current main object.
RequestParser function callback used to go through the list of received buffer.
SecondCall second call enum.
Traverser api to handle tree traverses for type definitions.
TraverseResult Traverser result operation.
TraverserValues api to handle tree traverses for values.