sql_dialect.go

// apcore is a server framework for implementing an ActivityPub application.
// Copyright (C) 2019 Cory Slep
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package models

// SqlDialect is a SQL dialect provider.
//
// Note that the order for inputs and outputs listed matter.
type SqlDialect interface {
	/* Table Creation Statements */

	// CreateUsersTable for the User model.
	CreateUsersTable() string
	// CreateFedDataTable for the FedData model.
	CreateFedDataTable() string
	// CreateLocalDataTable for the LocalData model.
	CreateLocalDataTable() string
	// CreateInboxesTable for the Inboxes model.
	CreateInboxesTable() string
	// CreateOutboxesTable for the Outboxes model.
	CreateOutboxesTable() string
	// CreateDeliveryAttemptsTable for the DeliveryAttempts model.
	CreateDeliveryAttemptsTable() string
	// CreatePrivateKeysTable for the PrivateKeys model.
	CreatePrivateKeysTable() string
	// CreateClientInfosTable for the ClientInfos model.
	CreateClientInfosTable() string
	// CreateTokenInfosTable for the TokenInfos model.
	CreateTokenInfosTable() string
	// CreateFollowersTable for the Followers model.
	CreateFollowersTable() string
	// CreateFollowingTable for the Following model.
	CreateFollowingTable() string
	// CreateLikedTable for the Liked model.
	CreateLikedTable() string
	// CreatePoliciesTable for the Policies model.
	CreatePoliciesTable() string
	// CreateResolutionsTable for the Resolutions model.
	CreateResolutionsTable() string
	// CreateFirstPartyCredentialsTable for first party credentials model.
	CreateFirstPartyCredentialsTable() string

	/* Indexes */

	// CreateIndexIDFedDataTable creates an index on the `id` of a federated
	// data payload.
	CreateIndexIDFedDataTable() string
	// CreateIndexIDLocalDataTable creates an index on the `id` of a local
	// data payload.
	CreateIndexIDLocalDataTable() string
	// CreateIndexIDInboxesTable creates an index on the `id` of an inbox.
	CreateIndexIDInboxesTable() string
	// CreateIndexIDOutboxesTable creates an index on the `id` of an outbox.
	CreateIndexIDOutboxesTable() string
	// CreateIndexIDFollowersTable creates an index on the `id` of a
	// followers collection.
	CreateIndexIDFollowersTable() string
	// CreateIndexIDFollowingTable creates an index on the `id` of a
	// following collection.
	CreateIndexIDFollowingTable() string
	// CreateIndexIDLikedTable creates an index on the `id` of a liked
	// collection.
	CreateIndexIDLikedTable() string

	/* Queries */

	// InsertUser:
	//  Params
	//   Email       string
	//   Hashpass    []byte
	//   Salt        []byte
	//   Actor       []byte
	//   Privileges  []byte
	//   Preferences []byte
	//  Returns
	//   ID          string
	InsertUser() string
	// UpdateUserActor:
	//  Params
	//   ID          string
	//   Actor       []byte
	//  Returns
	UpdateUserActor() string
	// SensitiveUserByEmail:
	//  Params
	//   Email       string
	//  Returns
	//   ID          string
	//   Hashpass    []byte
	//   Salt        []byte
	SensitiveUserByEmail() string
	// UserByID:
	//  Params
	//   ID          string
	//  Returns
	//   ID          string
	//   Email       string
	//   Actor       []byte
	//   Privileges  []byte
	//   Preferences []byte
	UserByID() string
	// UserByPreferredUsername:
	//  Params
	//   Name        string
	//  Returns
	//   ID          string
	//   Email       string
	//   Actor       []byte
	//   Privileges  []byte
	//   Preferences []byte
	UserByPreferredUsername() string
	// ActorIDForOutbox:
	//  Params
	//   OutboxID    string
	//  Returns
	//   ActorID     string
	ActorIDForOutbox() string
	// ActorIDForInbox:
	//  Params
	//   InboxID     string
	//  Returns
	//   ActorID     string
	ActorIDForInbox() string
	// UpdateUserPreferences:
	//  Params
	//   ID          string
	//   Preferences []byte
	//  Returns
	UpdateUserPreferences() string
	// UpdateUserPrivileges:
	//  Params
	//   ID          string
	//   Privileges  []byte
	//  Returns
	UpdateUserPrivileges() string
	// InstanceUser:
	//  Params
	//  Returns
	//   ID          string
	//   Email       string
	//   Actor       []byte
	//   Privileges  []byte
	//   Preferences []byte
	InstanceUser() string
	// GetInstanceActorProfile:
	//  Params
	//  Returns
	//   Prefs          []byte
	GetInstanceActorPreferences() string
	// SetInstanceActorProfile:
	//  Params
	//   Prefs          []byte
	//  Returns
	SetInstanceActorPreferences() string
	// GetUserActivityStats:
	//  Params
	//  Returns
	//   TotalUsers     int
	//   ActiveHalfYear int
	//   ActiveMonth    int
	//   ActiveWeek     int
	GetUserActivityStats() string

	// FedExists:
	//  Params
	//   ID          string
	//  Returns
	//   Exists      bool
	FedExists() string
	// FedGet:
	//  Params
	//   ID          string
	//  Returns
	//   Payload     []byte
	FedGet() string
	// FedCreate:
	//  Params
	//   Payload     []byte
	//  Returns
	FedCreate() string
	// FedUpdate:
	//  Params
	//   ID          string
	//   Payload     []byte
	//  Returns
	FedUpdate() string
	// FedDelete:
	//  Params
	//   ID          string
	//  Returns
	FedDelete() string

	// LocalExists:
	//  Params
	//   ID          string
	//  Returns
	//   Exists      bool
	LocalExists() string
	// LocalGet:
	//  Params
	//   ID          string
	//  Returns
	//   Payload     []byte
	LocalGet() string
	// LocalCreate:
	//  Params
	//   Payload     []byte
	//  Returns
	LocalCreate() string
	// LocalUpdate:
	//  Params
	//   ID          string
	//   Payload     []byte
	//  Returns
	LocalUpdate() string
	// LocalDelete:
	//  Params
	//   ID          string
	//  Returns
	LocalDelete() string
	// LocalStats:
	//  Params
	//  Returns
	//   NLocalPosts    int
	//   NLocalComments int
	LocalStats() string

	// InsertInbox:
	//  Params
	//   ActorID     string
	//   Inbox      []byte
	//  Returns
	InsertInbox() string
	// InboxContainsForActor:
	//  Params
	//   ActorID     string
	//   Item        string
	//  Returns
	//   Contains    bool
	InboxContainsForActor() string
	// InboxContains:
	//  Params
	//   InboxID     string
	//   Item        string
	//  Returns
	//   Contains    bool
	InboxContains() string
	// GetInbox:
	//  Params
	//   Inbox       string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetInbox() string
	// GetPublicInbox:
	//  Params
	//   Inbox       string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetPublicInbox() string
	// GetInboxLastPage:
	//  Params
	//   Inbox       string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetInboxLastPage() string
	// GetPublicInboxLastPage:
	//  Params
	//   Inbox       string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetPublicInboxLastPage() string
	// PrependInboxItem:
	//  Params
	//   Inbox       string
	//   Item        string
	//  Returns
	PrependInboxItem() string
	// DeleteInboxItem:
	//  Params
	//   Inbox       string
	//   Item        string
	//  Returns
	DeleteInboxItem() string

	// InsertOutbox:
	//  Params
	//   ActorID     string
	//   Outbox      []byte
	//  Returns
	InsertOutbox() string
	// OutboxContainsForActor:
	//  Params
	//   ActorID     string
	//   Item        string
	//  Returns
	//   Contains    bool
	OutboxContainsForActor() string
	// OutboxContains:
	//  Params
	//   OutboxID    string
	//   Item        string
	//  Returns
	//   Contains    bool
	OutboxContains() string
	// GetOutbox:
	//  Params
	//   Outbox      string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetOutbox() string
	// GetPublicOutbox:
	//  Params
	//   Outbox      string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetPublicOutbox() string
	// GetOutboxLastPage:
	//  Params
	//   Outbox      string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetOutboxLastPage() string
	// GetPublicOutboxLastPage:
	//  Params
	//   Outbox      string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetPublicOutboxLastPage() string
	// PrependOutboxItem:
	//  Params
	//   Outbox      string
	//   Item        string
	//  Returns
	PrependOutboxItem() string
	// DeleteOutboxItem:
	//  Params
	//   Outbox      string
	//   Item        string
	//  Returns
	DeleteOutboxItem() string
	// OutboxForInbox:
	//  Params
	//   Inbox       string
	//  Returns
	//   Outbox      string
	OutboxForInbox() string

	// InsertAttempt:
	//  Params
	//   FromID      string
	//   ToActor     string
	//   Payload     []byte
	//   State       string
	//  Returns
	//   ID          string
	InsertAttempt() string
	// MarkSuccessfulAttempt:
	//  Params
	//   ID          string
	//  Returns
	MarkSuccessfulAttempt() string
	// MarkFailedAttempt:
	//  Params
	//   ID          string
	//  Returns
	MarkFailedAttempt() string
	// MarkAbandonedAttempt:
	//  Params
	//   ID          string
	//  Returns
	MarkAbandonedAttempt() string
	// FirstPageRetryableFailures:
	//  Params
	//   State       string
	//   FetchTime   time.Time
	//   Limit       int
	//  Returns
	//   ID          string
	//   FromID      string
	//   DeliverTo   string
	//   Payload     []byte
	//   NAttempts   int
	//   LastAttempt time.Time
	FirstPageRetryableFailures() string
	// NextPageRetryableFailures:
	//  Params
	//   State       string
	//   FetchTime   time.Time
	//   Limit       int
	//   PrevID      string
	//  Returns
	//   ID          string
	//   FromID      string
	//   DeliverTo   string
	//   Payload     []byte
	//   NAttempts   int
	//   LastAttempt time.Time
	NextPageRetryableFailures() string

	// CreatePrivateKey:
	//  Params
	//   UserID      string
	//   Purpose     string
	//   PrivKey     []byte
	//  Returns
	CreatePrivateKey() string
	// GetPrivateKeyByUserID:
	//  Params
	//   UserID      string
	//   Purpose     string
	//  Returns
	//   PrivKey     []byte
	GetPrivateKeyByUserID() string
	// GetPrivateKeyForInstanceActor:
	//  Params
	//   Purpose     string
	//  Returns
	//   PrivKey     []byte
	GetPrivateKeyForInstanceActor() string

	// CreateClientInfo:
	//  Params
	//   Secret      string
	//   Domain      string
	//   UserID      string
	//  Returns
	//   ID          string
	CreateClientInfo() string
	// GetClientInfoByID:
	//  Params
	//   ID          string
	//  Returns
	//   ID          string
	//   Secret      string
	//   Domain      string
	//   UserID      string
	GetClientInfoByID() string

	// CreateTokenInfo:
	//  Params
	//   ClientID    string
	//   UserID      string
	//   RedirURI    string
	//   Scope       string
	//   Code        string
	//   CodeCreated time.Time
	//   CodeExpires time.Duration
	//   CodeChal    string
	//   CodeChalMtd string
	//   Access      string
	//   AccessCtd   time.Time
	//   AccessExp   time.Duration
	//   Refresh     string
	//   RefrCreated time.Time
	//   RefrExpires time.Duration
	//  Returns
	//   ID          string
	CreateTokenInfo() string
	// RemoveTokenInfoByCode:
	//  Params
	//   Code        string
	//  Returns
	RemoveTokenInfoByCode() string
	// RemoveTokenInfoByAccess:
	//  Params
	//   Access      string
	//  Returns
	RemoveTokenInfoByAccess() string
	// RemoveTokenInfoByRefresh:
	//  Params
	//   Refresh     string
	//  Returns
	RemoveTokenInfoByRefresh() string
	// GetTokenInfoByCode:
	//  Params
	//   Code        string
	//  Returns
	//   ClientID    string
	//   UserID      string
	//   RedirURI    string
	//   Scope       string
	//   Code        string
	//   CodeCreated time.Time
	//   CodeExpires time.Duration
	//   CodeChal    string
	//   CodeChalMtd string
	//   Access      string
	//   AccessCtd   time.Time
	//   AccessExp   time.Duration
	//   Refresh     string
	//   RefrCreated time.Time
	//   RefrExpires time.Duration
	GetTokenInfoByCode() string
	// GetTokenInfoByAccess:
	//  Params
	//   Access      string
	//  Returns
	//   ClientID    string
	//   UserID      string
	//   RedirURI    string
	//   Scope       string
	//   Code        string
	//   CodeCreated time.Time
	//   CodeExpires time.Duration
	//   CodeChal    string
	//   CodeChalMtd string
	//   Access      string
	//   AccessCtd   time.Time
	//   AccessExp   time.Duration
	//   Refresh     string
	//   RefrCreated time.Time
	//   RefrExpires time.Duration
	GetTokenInfoByAccess() string
	// GetTokenInfoByRefresh:
	//  Params
	//   Refresh     string
	//  Returns
	//   ClientID    string
	//   UserID      string
	//   RedirURI    string
	//   Scope       string
	//   Code        string
	//   CodeCreated time.Time
	//   CodeExpires time.Duration
	//   CodeChal    string
	//   CodeChalMtd string
	//   Access      string
	//   AccessCtd   time.Time
	//   AccessExp   time.Duration
	//   Refresh     string
	//   RefrCreated time.Time
	//   RefrExpires time.Duration
	GetTokenInfoByRefresh() string

	// InsertFollowers:
	//  Params
	//   ActorID     string
	//   Followers   []byte
	//  Returns
	InsertFollowers() string
	// FollowersContainsForActor:
	//  Params
	//   ActorID     string
	//   Item        string
	//  Returns
	//   Contains    bool
	FollowersContainsForActor() string
	// FollowersContains:
	//  Params
	//   Followers   string
	//   Item        string
	//  Returns
	//   Contains    bool
	FollowersContains() string
	// GetFollowers:
	//  Params
	//   Followers   string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetFollowers() string
	// GetFollowersLastPage:
	//  Params
	//   Followers   string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetFollowersLastPage() string
	// PrependFollowersItem:
	//  Params
	//   Followers   string
	//   Item        string
	//  Returns
	PrependFollowersItem() string
	// DeleteFollowersItem:
	//  Params
	//   Followers   string
	//   Item        string
	//  Returns
	DeleteFollowersItem() string
	// GetAllFollowersForActor:
	//  Params
	//   Followers   string
	//  Returns
	//   Followers   []byte
	GetAllFollowersForActor() string

	// InsertFollowing:
	//  Params
	//   ActorID     string
	//   Following   []byte
	//  Returns
	InsertFollowing() string
	// FollowingContainsForActor:
	//  Params
	//   ActorID     string
	//   Item        string
	//  Returns
	//   Contains    bool
	FollowingContainsForActor() string
	// FollowingContains:
	//  Params
	//   Following   string
	//   Item        string
	//  Returns
	//   Contains    bool
	FollowingContains() string
	// GetFollowing:
	//  Params
	//   Following   string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetFollowing() string
	// GetFollowingLastPage:
	//  Params
	//   Following   string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetFollowingLastPage() string
	// PrependFollowingItem:
	//  Params
	//   Following   string
	//   Item        string
	//  Returns
	PrependFollowingItem() string
	// DeleteFollowingItem:
	//  Params
	//   Following   string
	//   Item        string
	//  Returns
	DeleteFollowingItem() string
	// GetAllFollowingForActor:
	//  Params
	//   Following   string
	//  Returns
	//   Following   []byte
	GetAllFollowingForActor() string

	// InsertLiked:
	//  Params
	//   ActorID     string
	//   Liked       []byte
	//  Returns
	InsertLiked() string
	// LikedContainsForActor:
	//  Params
	//   ActorID     string
	//   Item        string
	//  Returns
	//   Contains    bool
	LikedContainsForActor() string
	// LikedContains:
	//  Params
	//   Liked       string
	//   Item        string
	//  Returns
	//   Contains    bool
	LikedContains() string
	// GetLiked:
	//  Params
	//   Liked       string
	//   Min         int
	//   Max         int
	//  Returns
	//   Page        []byte
	//   IsEnd       bool
	GetLiked() string
	// GetLikedLastPage:
	//  Params
	//   Liked       string
	//   N           int
	//  Returns
	//   Page        []byte
	//   StartIndex  int
	GetLikedLastPage() string
	// PrependLikedItem:
	//  Params
	//   Liked       string
	//   Item        string
	//  Returns
	PrependLikedItem() string
	// DeleteLikedItem:
	//  Params
	//   Liked       string
	//   Item        string
	//  Returns
	DeleteLikedItem() string
	// GetAllLikedForActor:
	//  Params
	//   Liked       string
	//  Returns
	//   Liked       []byte
	GetAllLikedForActor() string

	// CreatePolicy:
	//  Params
	//   ActorID     string
	//   Purpose     string
	//   Payload     []byte
	//  Returns
	//   ID          string
	CreatePolicy() string
	// GetPoliciesForActor:
	//  Params
	//   ActorID     string
	//  Returns (Multiple)
	//   ID          string
	//   Purpose     string
	//   Payload     []byte
	GetPoliciesForActor() string
	// GetPoliciesForActorAndPurpose:
	//  Params
	//   ActorID     string
	//   Purpose     string
	//  Returns (Multiple)
	//   ID          string
	//   Payload     []byte
	GetPoliciesForActorAndPurpose() string

	// CreateResolution:
	//  Params
	//   PolicyID    string
	//   DataIRI     string
	//   Payload     []byte
	//  Returns
	CreateResolution() string

	// CreateFirstPartyCredential:
	//  Params
	//   UserID      string
	//   TokenID     string
	//   Expires     time.Time
	//  Returns
	//   ID          string
	CreateFirstPartyCredential() string
	// UpdateFirstPartyCredential:
	//  Params
	//   ID          string
	//   ClientID    string
	//   UserID      string
	//   RedirURI    string
	//   Scope       string
	//   Code        string
	//   CodeCreated time.Time
	//   CodeExpires time.Duration
	//   CodeChal    string
	//   CodeChalMtd string
	//   Access      string
	//   AccessCtd   time.Time
	//   AccessExp   time.Duration
	//   Refresh     string
	//   RefrCreated time.Time
	//   RefrExpires time.Duration
	//  Returns
	UpdateFirstPartyCredential() string
	// UpdateFirstPartyCredentialExpires:
	//  Params
	//   ID          string
	//   Expires     time.Time
	//  Returns
	UpdateFirstPartyCredentialExpires() string
	// RemoveFirstPartyCredential:
	//  Params
	//   ID          string
	//  Returns
	RemoveFirstPartyCredential() string
	// RemoveExpiredFirstPartyCredentials:
	//  Params
	//  Returns
	RemoveExpiredFirstPartyCredentials() string
	// GetTokenInfoForCredentialID:
	//  Params
	//   ID          string
	//  Returns
	//   ClientID    string
	//   UserID      string
	//   RedirURI    string
	//   Scope       string
	//   Code        string
	//   CodeCreated time.Time
	//   CodeExpires time.Duration
	//   CodeChal    string
	//   CodeChalMtd string
	//   Access      string
	//   AccessCtd   time.Time
	//   AccessExp   time.Duration
	//   Refresh     string
	//   RefrCreated time.Time
	//   RefrExpires time.Duration
	GetTokenInfoForCredentialID() string

	// GetOpenFollowRequests
	//  Params
	//   ID          string
	//  Returns (Multiple)
	//   Payload     []byte
	GetOpenFollowRequests() string
}