Documentation
¶
Overview ¶
Copyright 2025 Google LLC
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- func GetCloudSQLOpts(ipType, userAgent string, useIAM bool) ([]cloudsqlconn.Option, error)
- func GetIAMAccessToken(ctx context.Context) (string, error)
- func GetIAMPrincipalEmailFromADC(ctx context.Context, dbType string) (string, error)
- func InitConnectionSpan(ctx context.Context, tracer trace.Tracer, sourceType, sourceName string) (context.Context, trace.Span)
- func Register(sourceType string, factory SourceConfigFactory) bool
- type Cache
- type Dialect
- type IPType
- type Item
- type OnEvictFunc
- type Source
- type SourceConfig
- type SourceConfigFactory
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetCloudSQLOpts ¶ added in v0.1.0
func GetCloudSQLOpts(ipType, userAgent string, useIAM bool) ([]cloudsqlconn.Option, error)
GetCloudSQLDialOpts retrieve dial options with the right ip type and user agent for cloud sql databases.
func GetIAMAccessToken ¶ added in v0.8.0
func GetIAMPrincipalEmailFromADC ¶ added in v0.4.0
GetIAMPrincipalEmailFromADC finds the email associated with ADC
func InitConnectionSpan ¶ added in v0.0.5
func InitConnectionSpan(ctx context.Context, tracer trace.Tracer, sourceType, sourceName string) (context.Context, trace.Span)
InitConnectionSpan adds a span for database pool connection initialization
func Register ¶ added in v0.7.0
func Register(sourceType string, factory SourceConfigFactory) bool
Register registers a new source type with its factory. It returns false if the type is already registered.
Types ¶
type Cache ¶ added in v0.27.0
type Cache struct {
// contains filtered or unexported fields
}
Cache is a thread-safe, expiring key-value store
func NewCache ¶ added in v0.27.0
func NewCache(onEvict OnEvictFunc) *Cache
NewCache creates a new cache and cleans up every 55 min
func (*Cache) DeleteExpired ¶ added in v0.27.0
func (c *Cache) DeleteExpired()
DeleteExpired removes all expired items
type Dialect ¶ added in v0.0.3
type Dialect string
Dialect represents the dialect type of a database.
type OnEvictFunc ¶ added in v0.27.0
OnEvictFunc is the signature for the callback
type Source ¶
type Source interface {
SourceType() string
ToConfig() SourceConfig
}
Source is the interface for the source itself.
type SourceConfig ¶ added in v0.0.2
type SourceConfig interface {
SourceConfigType() string
Initialize(ctx context.Context, tracer trace.Tracer) (Source, error)
}
SourceConfig is the interface for configuring a source.
func DecodeConfig ¶ added in v0.7.0
func DecodeConfig(ctx context.Context, sourceType string, name string, decoder *yaml.Decoder) (SourceConfig, error)
DecodeConfig decodes a source configuration using the registered factory for the given type.
type SourceConfigFactory ¶ added in v0.7.0
type SourceConfigFactory func(ctx context.Context, name string, decoder *yaml.Decoder) (SourceConfig, error)
SourceConfigFactory defines the function signature for creating a SourceConfig.
Source Files
Directories