Documentation ¶
Overview ¶
Package ppsdb contains the database schema that PPS uses.
Index ¶
- Variables
- func ClusterDefaults(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
- func CollectionsV0() []col.PostgresCollection
- func CollectionsV2_7_0() []col.PostgresCollection
- func CollectionsV2_8_0() []col.PostgresCollection
- func JobKey(j *pps.Job) string
- func Jobs(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
- func JobsPipelineKey(p *pps.Pipeline) string
- func JobsTerminalKey(pipeline *pps.Pipeline, isTerminal bool) string
- func ParsePipelineKey(key string) (projectName, pipelineName, id string, err error)
- func Pipelines(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
- func PipelinesNameKey(p *pps.Pipeline) string
- func ProjectDefaults(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
- func VersionKey(p *pps.Pipeline, version uint64) string
- type ClusterDefaultsWrapper
- func (*ClusterDefaultsWrapper) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterDefaultsWrapper) GetJson() string
- func (x *ClusterDefaultsWrapper) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*ClusterDefaultsWrapper) ProtoMessage()
- func (x *ClusterDefaultsWrapper) ProtoReflect() protoreflect.Message
- func (x *ClusterDefaultsWrapper) Reset()
- func (x *ClusterDefaultsWrapper) String() string
- func (m *ClusterDefaultsWrapper) Validate() error
- func (m *ClusterDefaultsWrapper) ValidateAll() error
- type ClusterDefaultsWrapperMultiError
- type ClusterDefaultsWrapperValidationError
- func (e ClusterDefaultsWrapperValidationError) Cause() error
- func (e ClusterDefaultsWrapperValidationError) Error() string
- func (e ClusterDefaultsWrapperValidationError) ErrorName() string
- func (e ClusterDefaultsWrapperValidationError) Field() string
- func (e ClusterDefaultsWrapperValidationError) Key() bool
- func (e ClusterDefaultsWrapperValidationError) Reason() string
- type ProjectDefaultsWrapper
- func (*ProjectDefaultsWrapper) Descriptor() ([]byte, []int)deprecated
- func (x *ProjectDefaultsWrapper) GetJson() string
- func (x *ProjectDefaultsWrapper) MarshalLogObject(enc zapcore.ObjectEncoder) error
- func (*ProjectDefaultsWrapper) ProtoMessage()
- func (x *ProjectDefaultsWrapper) ProtoReflect() protoreflect.Message
- func (x *ProjectDefaultsWrapper) Reset()
- func (x *ProjectDefaultsWrapper) String() string
- func (m *ProjectDefaultsWrapper) Validate() error
- func (m *ProjectDefaultsWrapper) ValidateAll() error
- type ProjectDefaultsWrapperMultiError
- type ProjectDefaultsWrapperValidationError
- func (e ProjectDefaultsWrapperValidationError) Cause() error
- func (e ProjectDefaultsWrapperValidationError) Error() string
- func (e ProjectDefaultsWrapperValidationError) ErrorName() string
- func (e ProjectDefaultsWrapperValidationError) Field() string
- func (e ProjectDefaultsWrapperValidationError) Key() bool
- func (e ProjectDefaultsWrapperValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_internal_ppsdb_ppsdb_proto protoreflect.FileDescriptor
var JobsJobSetIndex = &col.Index{ Name: "jobset", Extract: func(val proto.Message) string { return val.(*pps.JobInfo).Job.Id }, }
var JobsPipelineIndex = &col.Index{ Name: "pipeline", Extract: func(val proto.Message) string { return JobsPipelineKey(val.(*pps.JobInfo).Job.Pipeline) }, }
JobsPipelineIndex maps pipeline to Jobs started by the pipeline
var JobsTerminalIndex = &col.Index{ Name: "job_state", Extract: func(val proto.Message) string { jobInfo := val.(*pps.JobInfo) return JobsTerminalKey(jobInfo.Job.Pipeline, pps.IsTerminal(jobInfo.State)) }, }
var PipelinesNameIndex = &col.Index{ Name: "name", Extract: func(val proto.Message) string { return PipelinesNameKey(val.(*pps.PipelineInfo).Pipeline) }, }
PipelinesNameIndex records the name of pipelines
var PipelinesVersionIndex = &col.Index{ Name: "version", Extract: func(val proto.Message) string { info := val.(*pps.PipelineInfo) return VersionKey(info.Pipeline, info.Version) }, }
PipelinesVersionIndex records the version numbers of pipelines
Functions ¶
func ClusterDefaults ¶ added in v2.7.0
func ClusterDefaults(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
ClusterDefaults returns a PostgresCollection of cluster defaults. Note that this is a singleton table.
func CollectionsV0 ¶
func CollectionsV0() []col.PostgresCollection
CollectionsV0 returns a list of all the PPS API collections for postgres-initialization purposes. These collections are not usable for querying. DO NOT MODIFY THIS FUNCTION IT HAS BEEN USED IN A RELEASED MIGRATION
func CollectionsV2_7_0 ¶ added in v2.7.0
func CollectionsV2_7_0() []col.PostgresCollection
CollectionsV2_7_0 returns a list of collections for postgres-initialization purposes. These collections are not usable for querying.
DO NOT MODIFY THIS FUNCTION IT HAS BEEN USED IN A RELEASED MIGRATION
func CollectionsV2_8_0 ¶ added in v2.8.0
func CollectionsV2_8_0() []col.PostgresCollection
CollectionsV2_8_0 returns a list of collections for postgres-initialization purposes. These collections are not usable for querying.
DO NOT MODIFY THIS FUNCTION IT HAS BEEN USED IN A RELEASED MIGRATION
func JobKey ¶
JobKey is a string representation of a Job suitable for use as an indexing key. It will include the project if the project name is not the empty string.
func Jobs ¶
func Jobs(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
Jobs returns a PostgresCollection of Jobs
func JobsPipelineKey ¶
func ParsePipelineKey ¶
ParsePipelineKey expects keys to either be of the form <pipeline>@<id> or <project>/<pipeline>@<id>.
func Pipelines ¶
func Pipelines(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
Pipelines returns a PostgresCollection of pipelines
func PipelinesNameKey ¶
PipelinesNameKey returns the key used by PipelinesNameIndex to index a PipelineInfo.
func ProjectDefaults ¶ added in v2.8.0
func ProjectDefaults(db *pachsql.DB, listener col.PostgresListener) col.PostgresCollection
ProjectDefaults returns a PostgresCollection of project defaults. Note that this is a singleton table.
func VersionKey ¶
VersionKey return a unique key for the given project, pipeline & version. If the project is the empty string it will return an old-style key without a project; otherwise the key will include the project. The version is zero-padded in order to facilitate sorting.
Types ¶
type ClusterDefaultsWrapper ¶ added in v2.8.0
type ClusterDefaultsWrapper struct { Json string `protobuf:"bytes,3,opt,name=json,proto3" json:"json,omitempty"` // contains filtered or unexported fields }
func (*ClusterDefaultsWrapper) Descriptor
deprecated
added in
v2.8.0
func (*ClusterDefaultsWrapper) Descriptor() ([]byte, []int)
Deprecated: Use ClusterDefaultsWrapper.ProtoReflect.Descriptor instead.
func (*ClusterDefaultsWrapper) GetJson ¶ added in v2.8.0
func (x *ClusterDefaultsWrapper) GetJson() string
func (*ClusterDefaultsWrapper) MarshalLogObject ¶ added in v2.8.0
func (x *ClusterDefaultsWrapper) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*ClusterDefaultsWrapper) ProtoMessage ¶ added in v2.8.0
func (*ClusterDefaultsWrapper) ProtoMessage()
func (*ClusterDefaultsWrapper) ProtoReflect ¶ added in v2.8.0
func (x *ClusterDefaultsWrapper) ProtoReflect() protoreflect.Message
func (*ClusterDefaultsWrapper) Reset ¶ added in v2.8.0
func (x *ClusterDefaultsWrapper) Reset()
func (*ClusterDefaultsWrapper) String ¶ added in v2.8.0
func (x *ClusterDefaultsWrapper) String() string
func (*ClusterDefaultsWrapper) Validate ¶ added in v2.8.0
func (m *ClusterDefaultsWrapper) Validate() error
Validate checks the field values on ClusterDefaultsWrapper with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*ClusterDefaultsWrapper) ValidateAll ¶ added in v2.8.0
func (m *ClusterDefaultsWrapper) ValidateAll() error
ValidateAll checks the field values on ClusterDefaultsWrapper with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ClusterDefaultsWrapperMultiError, or nil if none found.
type ClusterDefaultsWrapperMultiError ¶ added in v2.8.0
type ClusterDefaultsWrapperMultiError []error
ClusterDefaultsWrapperMultiError is an error wrapping multiple validation errors returned by ClusterDefaultsWrapper.ValidateAll() if the designated constraints aren't met.
func (ClusterDefaultsWrapperMultiError) AllErrors ¶ added in v2.8.0
func (m ClusterDefaultsWrapperMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ClusterDefaultsWrapperMultiError) Error ¶ added in v2.8.0
func (m ClusterDefaultsWrapperMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ClusterDefaultsWrapperValidationError ¶ added in v2.8.0
type ClusterDefaultsWrapperValidationError struct {
// contains filtered or unexported fields
}
ClusterDefaultsWrapperValidationError is the validation error returned by ClusterDefaultsWrapper.Validate if the designated constraints aren't met.
func (ClusterDefaultsWrapperValidationError) Cause ¶ added in v2.8.0
func (e ClusterDefaultsWrapperValidationError) Cause() error
Cause function returns cause value.
func (ClusterDefaultsWrapperValidationError) Error ¶ added in v2.8.0
func (e ClusterDefaultsWrapperValidationError) Error() string
Error satisfies the builtin error interface
func (ClusterDefaultsWrapperValidationError) ErrorName ¶ added in v2.8.0
func (e ClusterDefaultsWrapperValidationError) ErrorName() string
ErrorName returns error name.
func (ClusterDefaultsWrapperValidationError) Field ¶ added in v2.8.0
func (e ClusterDefaultsWrapperValidationError) Field() string
Field function returns field value.
func (ClusterDefaultsWrapperValidationError) Key ¶ added in v2.8.0
func (e ClusterDefaultsWrapperValidationError) Key() bool
Key function returns key value.
func (ClusterDefaultsWrapperValidationError) Reason ¶ added in v2.8.0
func (e ClusterDefaultsWrapperValidationError) Reason() string
Reason function returns reason value.
type ProjectDefaultsWrapper ¶ added in v2.8.0
type ProjectDefaultsWrapper struct { Json string `protobuf:"bytes,3,opt,name=json,proto3" json:"json,omitempty"` // contains filtered or unexported fields }
func (*ProjectDefaultsWrapper) Descriptor
deprecated
added in
v2.8.0
func (*ProjectDefaultsWrapper) Descriptor() ([]byte, []int)
Deprecated: Use ProjectDefaultsWrapper.ProtoReflect.Descriptor instead.
func (*ProjectDefaultsWrapper) GetJson ¶ added in v2.8.0
func (x *ProjectDefaultsWrapper) GetJson() string
func (*ProjectDefaultsWrapper) MarshalLogObject ¶ added in v2.8.0
func (x *ProjectDefaultsWrapper) MarshalLogObject(enc zapcore.ObjectEncoder) error
func (*ProjectDefaultsWrapper) ProtoMessage ¶ added in v2.8.0
func (*ProjectDefaultsWrapper) ProtoMessage()
func (*ProjectDefaultsWrapper) ProtoReflect ¶ added in v2.8.0
func (x *ProjectDefaultsWrapper) ProtoReflect() protoreflect.Message
func (*ProjectDefaultsWrapper) Reset ¶ added in v2.8.0
func (x *ProjectDefaultsWrapper) Reset()
func (*ProjectDefaultsWrapper) String ¶ added in v2.8.0
func (x *ProjectDefaultsWrapper) String() string
func (*ProjectDefaultsWrapper) Validate ¶ added in v2.8.0
func (m *ProjectDefaultsWrapper) Validate() error
Validate checks the field values on ProjectDefaultsWrapper with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*ProjectDefaultsWrapper) ValidateAll ¶ added in v2.8.0
func (m *ProjectDefaultsWrapper) ValidateAll() error
ValidateAll checks the field values on ProjectDefaultsWrapper with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ProjectDefaultsWrapperMultiError, or nil if none found.
type ProjectDefaultsWrapperMultiError ¶ added in v2.8.0
type ProjectDefaultsWrapperMultiError []error
ProjectDefaultsWrapperMultiError is an error wrapping multiple validation errors returned by ProjectDefaultsWrapper.ValidateAll() if the designated constraints aren't met.
func (ProjectDefaultsWrapperMultiError) AllErrors ¶ added in v2.8.0
func (m ProjectDefaultsWrapperMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ProjectDefaultsWrapperMultiError) Error ¶ added in v2.8.0
func (m ProjectDefaultsWrapperMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ProjectDefaultsWrapperValidationError ¶ added in v2.8.0
type ProjectDefaultsWrapperValidationError struct {
// contains filtered or unexported fields
}
ProjectDefaultsWrapperValidationError is the validation error returned by ProjectDefaultsWrapper.Validate if the designated constraints aren't met.
func (ProjectDefaultsWrapperValidationError) Cause ¶ added in v2.8.0
func (e ProjectDefaultsWrapperValidationError) Cause() error
Cause function returns cause value.
func (ProjectDefaultsWrapperValidationError) Error ¶ added in v2.8.0
func (e ProjectDefaultsWrapperValidationError) Error() string
Error satisfies the builtin error interface
func (ProjectDefaultsWrapperValidationError) ErrorName ¶ added in v2.8.0
func (e ProjectDefaultsWrapperValidationError) ErrorName() string
ErrorName returns error name.
func (ProjectDefaultsWrapperValidationError) Field ¶ added in v2.8.0
func (e ProjectDefaultsWrapperValidationError) Field() string
Field function returns field value.
func (ProjectDefaultsWrapperValidationError) Key ¶ added in v2.8.0
func (e ProjectDefaultsWrapperValidationError) Key() bool
Key function returns key value.
func (ProjectDefaultsWrapperValidationError) Reason ¶ added in v2.8.0
func (e ProjectDefaultsWrapperValidationError) Reason() string
Reason function returns reason value.