README
¶
The primitives package is meant to contain definitions and constants that are widely used throughout this repository.
There should serve as the root package in that there should be no imports of any other Temporal package.
Documentation
¶
Index ¶
Constants ¶
const ( // GetHistoryMaxPageSize is the max page size for get history GetHistoryMaxPageSize = 256 // ReadDLQMessagesPageSize is the max page size for read DLQ messages ReadDLQMessagesPageSize = 1000 )
const ( // SystemLocalNamespace is namespace name for temporal system workflows running in local cluster SystemLocalNamespace = "temporal-system" // SystemNamespaceID is namespace id for all temporal system workflows SystemNamespaceID = "32049b68-7872-4094-8e63-d0dd59896a83" // SystemNamespaceRetention is retention config for all temporal system workflows SystemNamespaceRetention = time.Hour * 24 * 7 )
Namespace-related constants. This was flagged by salus as potentially hardcoded credentials. This is a false positive by the scanner and should be disregarded. #nosec
const ( DefaultWorkerTaskQueue = "default-worker-tq" PerNSWorkerTaskQueue = "temporal-sys-per-ns-tq" MigrationActivityTQ = "temporal-sys-migration-activity-tq" AddSearchAttributesActivityTQ = "temporal-sys-add-search-attributes-activity-tq" DeleteNamespaceActivityTQ = "temporal-sys-delete-namespace-activity-tq" DLQActivityTQ = "temporal-sys-dlq-activity-tq" )
all internal task queues shall be defined here such that we enhance security on top of them
const (
DefaultHistoryMaxAutoResetPoints = 20
)
const (
// DefaultTransactionSizeLimit is the largest allowed transaction size to persistence
DefaultTransactionSizeLimit = 4 * 1024 * 1024
)
const ( // DefaultWorkflowTaskTimeout sets the Default Workflow Task timeout for a Workflow DefaultWorkflowTaskTimeout = 10 * time.Second * debug.TimeoutMultiplier )
const (
ScheduleWorkflowIDPrefix = "temporal-sys-scheduler:"
)
Variables ¶
This section is empty.
Functions ¶
func CheckInternalPerNsTaskQueueAllowed ¶
CheckInternalPerNsTaskQueueAllowed tries to block the usage of internal per-namespace task queue for illegal cases. Parameters:
- targetTaskQueue: The task queue of the component.
- parentTaskQueue: The task queue of the parent component can be empty if the component has no parent.
Returns an error if the usage is illegal, or nil if it's allowed.
func MustValidateUUID ¶
MustValidateUUID parses and validates UUID contents from the given string representation returns empty string if the input is empty string panics if the given input is malformed
func UUIDString ¶
func ValidateUUID ¶
ValidateUUID parses and validates UUID contents from the given string representation returns:
- nil if the input is empty string
- error if input is malformed
- input if input can be parsed and is valid
Types ¶
type ServiceName ¶
type ServiceName string
const ( AllServices ServiceName = "all" FrontendService ServiceName = "frontend" InternalFrontendService ServiceName = "internal-frontend" HistoryService ServiceName = "history" MatchingService ServiceName = "matching" WorkerService ServiceName = "worker" ServerService ServiceName = "server" UnitTestService ServiceName = "unittest" )
These constants represent service roles
type UUID ¶
type UUID []byte
UUID represents a 16-byte universally unique identifier this type is a wrapper around google/uuid with the following differences
- type is a byte slice instead of [16]byte
- db serialization converts uuid to bytes as opposed to string
func MustParseUUID ¶
MustParseUUID returns a UUID parsed from the given string representation returns nil if the input is empty string panics if the given input is malformed
func ParseUUID ¶
ParseUUID returns a UUID parsed from the given string representation returns:
- nil if the input is empty string
- error if input is malformed
- UUID object if input can be parsed and is valid
func (UUID) Downcast ¶
Downcast returns the UUID as a byte slice. This is necessary when passing to type sensitive interfaces such as cql.
func (*UUID) Scan ¶
Scan implements sql.Scanner interface to allow this type to be parsed transparently by database drivers
func (UUID) String ¶
String returns the 36 byte hexstring representation of this uuid return empty string if this uuid is nil
Source Files
Directories