package
4.3.1
Repository: https://github.com/rpjoshl/rpdb.git
Documentation: pkg.go.dev

# Functions

ConvertDateTime converts the given time.Time struct into the custom wrapper DateTime.
NewAttribute decodes the JSON response of the given reader to a new attribute.
NewDateTime returns a wrapped time.Time object based on the given time string.
NewEntry decodes the JSON response of the given reader to a new Entry.
NewNullInt creates a new sql.NullInt32 with the given parameter.
NewNullString creates a new sql.NullString with the given parameter.
NewParameter is a helper function to create a single Parameter easilier on the fly with a single method call.
NewResponseMessage decodes the JSON response of the given reader to a new message.
NewUpdate decodes the JSON response of the given reader to a new Update.
NewUpdateWithData creates a new update object with the current version time and the given data.

# Constants

No description provided by the author
The current version string of the library.
The date on which the current version was released.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Use this value while filtering if you don't want to filter after a null string but either ignore the parameter while searching.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Date format the server understands and accepts.
Pretty time format for printing and debugging.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Attribute is used for grouping entries to a shqared "executable" operation.
AttributeExecResponse contains all information for the attribute type "exec_response" for which a response message and a code is expected to be returned to the client.
AttributeParameter specifies the number and order of parameters that can be used while creating an entry.
BulkResponse is used to return information the client needs about a bulk request.
BulkResponseData is a single data unit that was updated, deleted or created during the bulk operation.
DateTime is a time.Time object wrapped by custom marshal options to handle the parsing of the server time format.
Entry
Entry represents a single executable data unit.
EntryFilter is used to filter entries based on their properties.
EntryParameter contains the value of a specific command line argument when looking at it from an execution view.
ErrorResponse represents a custom error returned from the PHP server if the response was erroneous (status code 3xx or 4xx).
ErrorResponseDebug contains additional fields of the "ErrorResponse" which are only set when the debug mode was enabled in the server configuration.
Response of an execution for entries with an attribute of the type exec_response.
ParameterPreset is a object that countains predefined values for an pamarter of an attribute.
For every request a response message for the client is returned that contains a small phrase describing the operation and its status.
ResponseMessageWrapper is a wrapper around the struct "ResponseMessage" that should be uesed if the message is not included in another entity.
Update is used to apply updates received from the WebSocket (or the API) to the locally cached data.
UpdateData contains the objects that were deleted, updated or created.
WebSocketMessage is the root entity that contains different types of WebSocket messages.

# Interfaces

No description provided by the author

# Type aliases

BulkResponseStatus is a status flag of the operation for a single bulk operation data unit.
NullString is a wrapper around sql.NullInt32 that is encoded to a null on json marshal if it is not valid.
NullString is a wrapper around sql.NullString that is encoded to a null on json marshal if it is not valid.
Rights of the currently authenticated token for entries created with this attribute.
WebSocketMessageType defines the message type that was received by the WebSocket.