package
1.7.3
Repository: https://github.com/skygeario/skygear-server.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

DeriveFieldType finds the FieldType of the specified value.
GetAccessModel convert the string config to internal const.
No description provided by the author
NewAnonymousAuthInfo returns an anonymous AuthInfo, which has no Password.
No description provided by the author
NewAuthInfo returns a new AuthInfo with specified password.
No description provided by the author
NewEmptyReference returns a reference that is empty.
NewFieldACL returns a struct of FieldACL with a list of field ACL entries.
NewFieldACLIterator creates a new iterator.
NewFieldUserRole returns a FieldUserRole struct from the user role specification.
NewLocation returns a new Location.
No description provided by the author
NewProviderInfoAuthInfo returns an AuthInfo provided by a AuthProvider, which has no Password.
NewRecordACL returns a new RecordACL.
NewRecordACLEntryDirect returns an ACE for a specific user.
NewRecordACLEntryPublic return an ACE on public access.
NewRecordACLEntryRelation returns an ACE on relation.
NewRecordACLEntryRole return an ACE on role.
NewRecordID returns a new RecordID.
No description provided by the author
NewRows creates a new Rows.
Open returns an implementation of Conn to use w.r.t implName.
ParseFieldUserRole parses a user role string to a FieldUserRole.
Register makes an Skygear Server database driver available with the given name.
No description provided by the author
TraverseColumnTypes traverse the field type of a key path from database table.
No description provided by the author

# Constants

A list of Operator.
AnyUserFieldUserRoleType means field is accessible by any authenticated user.
A list of SordOrder, their meaning is self descriptive.
A list of SordOrder, their meaning is self descriptive.
CompareFieldAccessMode means the access mode is for query.
ReadLevel and WriteLevel is self-explanatory.
DefinedRoleFieldUserRoleType means field is accessible by a users of specific role.
A list of SordOrder, their meaning is self descriptive.
A list of SordOrder, their meaning is self descriptive.
DiscoverOrCompareFieldAccessMode means the access mode is for discovery or compare.
DynamicUserFieldUserRoleType means field is accessible by user contained in another field.
A list of Operator.
A list of ExpressionTypes.
A list of Operator.
A list of Operator.
A list of Operator.
A list of Operator.
A list of Operator.
A list of ExpressionTypes.
A list of Operator.
A list of Operator.
A list of Operator.
A list of ExpressionTypes.
A list of Operator.
A list of Operator.
A list of Operator.
OwnerFieldUserRoleType means field is accessible by the record owner.
PrivateDatabase is a database containing records visible to an individual user.
PublicDatabase is a database containing records shared among all users.
PublicFieldUserRoleType means field is accessible by public.
ReadFieldAccessMode means the access mode is for reading.
ReadLevel and WriteLevel is self-explanatory.
See the definition of RecordHookEvent.
See the definition of RecordHookEvent.
See the definition of RecordHookEvent.
RoleBasedAccess is traditional Role based Access Control RelationBasedAccess is Access Control determine by the user-user relation between creator and accessor.
RoleBasedAccess is traditional Role based Access Control RelationBasedAccess is Access Control determine by the user-user relation between creator and accessor.
SpecificUserFieldUserRoleType means field is accessible by a specific user.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
List of persistable data types in skydb.
UnionDatabase is a database containing all records in the PublicDatabase and all PrivateDatabase.
WildcardRecordField is a special record field that applies to all record fields.
WildcardRecordType is a special record type that applies to all record types.
WriteFieldAccessMode means the access mode is for writing.
ReadLevel and WriteLevel is self-explanatory.

# Variables

EmptyRows is a convenient variable that acts as an empty Rows.
ErrDatabaseIsReadOnly is returned by skydb.Database if the requested operation modifies the database and the database is readonly.
No description provided by the author
No description provided by the author
No description provided by the author
ErrDeviceNotFound is returned by Conn.GetDevice, Conn.DeleteDevice, Conn.DeleteDevicesByToken and Conn.DeleteEmptyDevicesByTime, if the desired Device cannot be found in the current container.
ErrRecordNotFound is returned from Get and Delete when Database cannot find the Record by the specified key.
No description provided by the author
ErrSubscriptionNotFound is returned from GetSubscription or DeleteSubscription when the specific subscription cannot be found.
ErrUserDuplicated is returned by Conn.CreateAuth when the AuthInfo to be created has the same ID/username in the current container.
ErrUserNotFound is returned by Conn.GetAuth, Conn.UpdateAuth and Conn.DeleteAuth when the AuthInfo's ID is not found in the current container.
No description provided by the author
No description provided by the author
ZeroTime represent a zero time.Time.

# Structs

AccessControlOptions provide access control options to query.
AppleAlert describes how a remote notification behaves and shows itself when received.
APSSetting describes how server should send a notification to a targeted device via Apple Push Service.
No description provided by the author
AuthData contains the unique authentication data of a user e.g.: {"username": "userA", "email": "[email protected]"}.
AuthInfo contains a user's information for authentication purpose.
CountFunc represents a function that count number of rows matching a query.
No description provided by the author
DBConfig represents optional configuration.
Device represents a device owned by a user and ready to receive notification.
DistanceFunc represents a function that calculates distance between a user supplied location and a Record's field.
An Expression represents value to be compared against.
FieldACL contains all field ACL rules for all record types.
FieldACLEntry contains a single field ACL entry.
FieldACLIterator iterates FieldACL to find a list of rules that apply to the specified record type and record field.
FieldType represents the kind of data living within a field of a RecordSchema.
FieldUserRole contains field user role information and checks whether a user matches the user role.
Index indicates the value of fields within a record type cannot be duplicated.
MemoryRows is a native implementation of RowIter.
NotificationInfo describes how server should send a notification to a target devices via a push service.
OAuthInfo contains 3rd provider information for authentication UserID is AuthInfo ID which incidcate user who link with the given oauth data.
PasswordHistory contains a password history of a user.
Predicate is a representation of used in query for filtering records.
Query specifies the type, predicate and sorting order of Database query.
QueryConfig provides optional parameters for queries.
Record is the primary entity of storage in Skygear.
RecordACLEntry grants access to a record by relation or by user_id.
RecordEvent describes a change event on Record which is either Created, Updated or Deleted.
RecordID identifies an unique record in a Database.
No description provided by the author
Rows implements a scanner-like interface for easy iteration on a result set returned from a query.
Sequence is a bogus data type for creating a sequence field via JIT schema migration.
Sort specifies the order of a collection of Records returned from a Query.
Subscription represents a device's subscription of notification triggered by changes of results from a query.
Unknown is a bogus data type denoting the type of a field is unknown.
UserRelationFunc represents a function that is used to evaulate whether a record satisfy certain user-based relation.

# Interfaces

Conn encapsulates the interface of an Skygear Server connection to a container.go:generate mockgen -destination=mock_skydb/mock_conn.go github.com/skygeario/skygear-server/pkg/server/skydb Conn.
No description provided by the author
Database represents a collection of record (either public or private) in a container.
Driver opens an connection to the underlying database.
ExpressionVisitor is an interface that implements the Visitor pattern for the Expression struct.
FullQueryVisitor is a marker interface for all query-related visitors.
Func is a marker interface to denote a type being a function in skydb.
KeyPathFunc is a marker interface to denote a func that references certain key paths.
PredicateVisitor is an interface that implements the Visitor pattern for the Predicate struct.
QueryVisitor is an interface that implements the Visitor pattern for the Query struct.
RowsIter is an iterator on results returned by execution of a query.
SortVisitor is an interface that implements the Visitor pattern for the Sort struct.
Transactional defines the methods for a persistence storage that supports transaction.
TxDatabase defines a Transactional Database go:generate mockgen -destination=mock_skydb/mock_tx_database.go github.com/skygeario/skygear-server/pkg/server/skydb TxDatabase.
Visitor is a marker interface.

# Type aliases

AccessModel indicates the type of access control model while db query.go:generate stringer -type=AccessModel.
A Data represents a key-value object used for storing ODRecord.
No description provided by the author
DataType defines the type of data that can saved into an skydb databasego:generate stringer -type=DataType.
DBHookFunc specifies the interface of a database hook function.
DBOpener aliases the function for opening Conn.
The DriverFunc type is an adapter such that an ordinary function can be used as a Driver.
ExpressionType is the type of an Expression.
FieldAccessMode is the intended access operation to be granted access.
FieldACLEntryList contains a list of field ACL entries.
FieldUserRoleType denotes the type of field user role, which specify who can access certain fields.
Geometry represent a geometry in GeoJSON.
Location represent a point of geometry.
Operator denotes how the result of a predicate is determined from its subpredicates or subexpressions.go:generate stringer -type=Operator.
ProviderInfo represents the dictionary of authenticated principal ID => authData.
No description provided by the author
RecordACL is a list of ACL entries defining access control for a record.
RecordACLLevel represent the operation a user granted on a resource.
RecordHookEvent indicates the type of record event that triggered the hook.
RecordSchema is a mapping of record key to its value's data type or reference.
SortOrder denotes an the order of Records returned from a Query.
No description provided by the author