Documentation
¶
Index ¶
- type APIKey
- type APIKeyKey
- type APIKeySpec
- type CreateProjectParams
- type CreateProjectUserParams
- type GetProjectParams
- type Organization
- type OrganizationUser
- type Project
- type ProjectUser
- type S
- func (s *S) AutoMigrate() error
- func (s *S) CreateAPIKey(spec APIKeySpec) (*APIKey, error)
- func (s *S) CreateOrganization(tenantID, orgID, title string, isDefault bool) (*Organization, error)
- func (s *S) CreateOrganizationUser(orgID, userID, role string) (*OrganizationUser, error)
- func (s *S) CreateProject(p CreateProjectParams) (*Project, error)
- func (s *S) CreateProjectUser(p CreateProjectUserParams) (*ProjectUser, error)
- func (s *S) DeleteAPIKey(k APIKeyKey) error
- func (s *S) DeleteOrganization(tenantID, orgID string) error
- func (s *S) DeleteOrganizationUser(orgID, userID string) error
- func (s *S) DeleteProject(tenantID, projectID string) error
- func (s *S) DeleteProjectUser(projectID, userID string) error
- func (s *S) GetAPIKeyByNameAndTenantID(name, tenantID string) (*APIKey, error)
- func (s *S) GetOrganizationByTenantIDAndOrgID(tenantID, orgID string) (*Organization, error)
- func (s *S) GetOrganizationByTenantIDAndTitle(tenantID, title string) (*Organization, error)
- func (s *S) GetProject(p GetProjectParams) (*Project, error)
- func (s *S) GetProjectByTenantIDAndTitle(tenantID, title string) (*Project, error)
- func (s *S) ListAPIKeysByTenantID(tenantID string) ([]*APIKey, error)
- func (s *S) ListAllAPIKeys() ([]*APIKey, error)
- func (s *S) ListAllOrganizationUsers() ([]OrganizationUser, error)
- func (s *S) ListAllOrganizations() ([]*Organization, error)
- func (s *S) ListAllProjectUsers() ([]ProjectUser, error)
- func (s *S) ListAllProjects() ([]*Project, error)
- func (s *S) ListOrganizationUsersByOrganizationID(orgID string) ([]OrganizationUser, error)
- func (s *S) ListOrganizations(tenantID string) ([]*Organization, error)
- func (s *S) ListProjectUsersByProjectID(projectID string) ([]ProjectUser, error)
- func (s *S) ListProjectsByTenantIDAndOrganizationID(tenantID, orgID string) ([]*Project, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIKey ¶
type APIKey struct { gorm.Model APIKeyID string `gorm:"uniqueIndex"` Name string `gorm:"uniqueIndex:idx_api_key_name_tenant_id"` TenantID string `gorm:"uniqueIndex:idx_api_key_name_tenant_id"` OrganizationID string ProjectID string UserID string Secret string }
APIKey represents an API key.
type APIKeyKey ¶
type APIKeyKey struct { APIKeyID string TenantID string OrganizationID string ProjectID string UserID string }
APIKeyKey represents a key of an API key.
type APIKeySpec ¶
APIKeySpec is a spec of the API key.
type CreateProjectParams ¶ added in v0.35.0
type CreateProjectParams struct { ProjectID string OrganizationID string TenantID string Title string KubernetesNamespace string IsDefault bool }
CreateProjectParams is the parameters for CreateProject.xo
type CreateProjectUserParams ¶ added in v0.35.0
type CreateProjectUserParams struct { ProjectID string OrganizationID string UserID string Role v1.ProjectRole }
CreateProjectUserParams is the parameters for CreateProjectUser.
type GetProjectParams ¶ added in v0.35.0
GetProjectParams is the parameters for GetProject.
type Organization ¶ added in v0.8.0
type Organization struct { gorm.Model OrganizationID string `gorm:"uniqueIndex"` TenantID string `gorm:"uniqueIndex:idx_orgs_tenant_id_title"` Title string `gorm:"uniqueIndex:idx_orgs_tenant_id_title"` IsDefault bool }
Organization is a model for organization
func (*Organization) ToProto ¶ added in v0.10.0
func (o *Organization) ToProto() *v1.Organization
ToProto converts the organization to proto.
type OrganizationUser ¶ added in v0.13.0
type OrganizationUser struct { gorm.Model OrganizationID string `gorm:"uniqueIndex:user_id_org_id"` UserID string `gorm:"uniqueIndex:user_id_org_id"` Role string }
OrganizationUser is a model for user_organization.
func (*OrganizationUser) ToProto ¶ added in v0.13.0
func (o *OrganizationUser) ToProto() *v1.OrganizationUser
ToProto converts the model to Porto.
type Project ¶ added in v0.35.0
type Project struct { gorm.Model ProjectID string `gorm:"uniqueIndex"` OrganizationID string TenantID string `gorm:"uniqueIndex:idx_projects_tenant_id_title"` Title string `gorm:"uniqueIndex:idx_projects_tenant_id_title"` IsDefault bool // KubernetesNamespace is the namespace where the fine-tuning jobs for the organization run. // TODO(kenji): Currently we don't set the unique constraint so that multiple orgs can use the same namespace, // but revisit the design. KubernetesNamespace string }
Project is a model for project.
type ProjectUser ¶ added in v0.35.0
type ProjectUser struct { gorm.Model ProjectID string `gorm:"uniqueIndex:user_id_project_id"` OrganizationID string UserID string `gorm:"uniqueIndex:user_id_project_id"` Role string }
ProjectUser is a model for user_project.
func (*ProjectUser) ToProto ¶ added in v0.35.0
func (p *ProjectUser) ToProto() *v1.ProjectUser
ToProto converts the model to Porto.
type S ¶
type S struct {
// contains filtered or unexported fields
}
S represents the data store.
func (*S) AutoMigrate ¶
AutoMigrate sets up the auto-migration task of the database.
func (*S) CreateAPIKey ¶
func (s *S) CreateAPIKey(spec APIKeySpec) (*APIKey, error)
CreateAPIKey creates a new API key.
func (*S) CreateOrganization ¶ added in v0.10.0
func (s *S) CreateOrganization(tenantID, orgID, title string, isDefault bool) (*Organization, error)
CreateOrganization creates a new organization.
func (*S) CreateOrganizationUser ¶ added in v0.13.0
func (s *S) CreateOrganizationUser(orgID, userID, role string) (*OrganizationUser, error)
CreateOrganizationUser creates a organization user.
func (*S) CreateProject ¶ added in v0.35.0
func (s *S) CreateProject(p CreateProjectParams) (*Project, error)
CreateProject creates a new project.
func (*S) CreateProjectUser ¶ added in v0.35.0
func (s *S) CreateProjectUser(p CreateProjectUserParams) (*ProjectUser, error)
CreateProjectUser creates a project user.
func (*S) DeleteAPIKey ¶
DeleteAPIKey deletes an APIKey by APIKey ID and tenant ID.
func (*S) DeleteOrganization ¶ added in v0.10.0
DeleteOrganization deletes an organization.
func (*S) DeleteOrganizationUser ¶ added in v0.22.0
DeleteOrganizationUser deletes a organization user.
func (*S) DeleteProject ¶ added in v0.35.0
DeleteProject deletes an project.
func (*S) DeleteProjectUser ¶ added in v0.35.0
DeleteProjectUser deletes a project user.
func (*S) GetAPIKeyByNameAndTenantID ¶ added in v0.7.0
GetAPIKeyByNameAndTenantID gets an API key by its name and tenant ID.
func (*S) GetOrganizationByTenantIDAndOrgID ¶ added in v0.21.0
func (s *S) GetOrganizationByTenantIDAndOrgID(tenantID, orgID string) (*Organization, error)
GetOrganizationByTenantIDAndOrgID gets an organization.
func (*S) GetOrganizationByTenantIDAndTitle ¶ added in v0.16.0
func (s *S) GetOrganizationByTenantIDAndTitle(tenantID, title string) (*Organization, error)
GetOrganizationByTenantIDAndTitle gets an organization By a tenant ID ID and a title.
func (*S) GetProject ¶ added in v0.35.0
func (s *S) GetProject(p GetProjectParams) (*Project, error)
GetProject gets an project.
func (*S) GetProjectByTenantIDAndTitle ¶ added in v0.35.0
GetProjectByTenantIDAndTitle gets an project ID by a tenant ID and a title.
func (*S) ListAPIKeysByTenantID ¶
ListAPIKeysByTenantID lists API keys by a tenant ID.
func (*S) ListAllAPIKeys ¶
ListAllAPIKeys lists all API keys.
func (*S) ListAllOrganizationUsers ¶ added in v0.13.0
func (s *S) ListAllOrganizationUsers() ([]OrganizationUser, error)
ListAllOrganizationUsers lists all organization users.
func (*S) ListAllOrganizations ¶ added in v0.25.0
func (s *S) ListAllOrganizations() ([]*Organization, error)
ListAllOrganizations lists all organizations.
func (*S) ListAllProjectUsers ¶ added in v0.35.0
func (s *S) ListAllProjectUsers() ([]ProjectUser, error)
ListAllProjectUsers lists all project users.
func (*S) ListAllProjects ¶ added in v0.35.0
ListAllProjects lists all projects.
func (*S) ListOrganizationUsersByOrganizationID ¶ added in v0.21.0
func (s *S) ListOrganizationUsersByOrganizationID(orgID string) ([]OrganizationUser, error)
ListOrganizationUsersByOrganizationID lists organization users in the specified organization.
func (*S) ListOrganizations ¶ added in v0.10.0
func (s *S) ListOrganizations(tenantID string) ([]*Organization, error)
ListOrganizations lists all organizations in the tenant.
func (*S) ListProjectUsersByProjectID ¶ added in v0.35.0
func (s *S) ListProjectUsersByProjectID(projectID string) ([]ProjectUser, error)
ListProjectUsersByProjectID lists project users in the specified project.