Versions in this module Expand all Collapse all v1 v1.11.0 Sep 10, 2026 v1.10.0 Aug 27, 2026 v1.9.0 Aug 14, 2026 Changes in this version + const MethodNameAuthProxy + const MethodNameConnector + const MethodNameDirectPrivateIP + const MethodNameUnixSocket + var AllDatabaseTypes = []DatabaseType + var AvailableLanguages = []Language + func DefaultDatabaseName(dbType DatabaseType) string + func ExtractNetworkName(path string) string + func FindVM(ctx context.Context, service *compute.Service, project, vmName string) (*compute.Instance, string, error) + func GenerateGKESidecarYAML(connectionName string, port int) string + func GenerateKubernetesSecretYAML(dbName string) string + func GetCloudRunRecommendations(sqlInfo *CloudSQLInstanceInfo, runInfo *CloudRunServiceInfo) (ConnectionRecommendation, []ConnectionRecommendation) + func GetComputeService(ctx context.Context, accessToken string) (*compute.Service, error) + func GetDatabasePort(dbType DatabaseType) int + func GetGCERecommendations(sqlInfo *CloudSQLInstanceInfo, vmInfo *GCEInstanceInfo, sameVPC bool) (ConnectionRecommendation, []ConnectionRecommendation) + func GetGKERecommendations(sqlInfo *CloudSQLInstanceInfo, gkeInfo *GKEClusterInfo, sameVPC bool) (ConnectionRecommendation, []ConnectionRecommendation) + func GetLocalRecommendations(sqlInfo *CloudSQLInstanceInfo) (ConnectionRecommendation, []ConnectionRecommendation) + func IsSameVPC(sqlVPC, vmVPC string) bool + func IsValidLanguage(lang string) bool + func ParseConnectionName(connName string) (project, region, instance string, err error) + func ValidateDatabaseName(name string) error + func ValidateGCEResourceName(name, kind string) error + func ValidateInstanceConnectionName(connName string) (project, region, instance string, err error) + func ValidateLanguage(lang string) error + type CloudRunServiceInfo struct + CloudSQLInstances []string + DirectVPCEgress bool + Name string + Project string + Region string + ServiceAccount string + VPCConnector string + type CloudSQLInstanceInfo struct + AuthorizedNetworks []string + ConnectionName string + DatabaseType DatabaseType + DatabaseVersion string + Name string + PrivateIPAddress string + PrivateIPEnabled bool + Project string + PublicIPAddress string + PublicIPEnabled bool + Region string + RequireSSL bool + VPCNetwork string + func ExtractSQLInfo(inst *sqladmin.DatabaseInstance) *CloudSQLInstanceInfo + type CodeSnippet struct + Code string + Dependencies []string + Language Language + Notes []string + func GenerateCodeSnippet(lang Language, method ConnectionMethod, dbType DatabaseType, ...) *CodeSnippet + type ComputeType string + const ComputeCloudRun + const ComputeGCE + const ComputeGKE + const ComputeLocal + type ConnectResult struct + AlternativeMethods []ConnectionRecommendation + AvailableLanguages []Language + CodeSnippet *CodeSnippet + ComputeLocation string + ComputeResource string + ComputeType ComputeType + ConnectionStrings ConnectionStrings + DatabaseType DatabaseType + DatabaseVersion string + EnvironmentConfig EnvironmentConfig + InstanceConnectionName string + Project string + RecommendedMethod ConnectionRecommendation + Region string + RequiredAPIs []string + RequiredIAMRoles []string + SetupSteps []SetupStep + Validation ValidationResult + type ConnectionMethod string + const MethodAuthProxy + const MethodConnector + const MethodDirectPrivateIP + const MethodUnixSocket + type ConnectionRecommendation struct + Complexity string + Considerations []string + Description string + Method ConnectionMethod + Name string + Performance string + Priority int + Requirements []string + Security string + type ConnectionStrings struct + DSN string + Host string + JDBC string + Port int + SocketPath string + func BuildConnectionStrings(method ConnectionMethod, dbType DatabaseType, sqlInfo *CloudSQLInstanceInfo, ...) ConnectionStrings + type DatabaseType string + const MySQL + const PostgreSQL + const SQLServer + func ParseDatabaseType(version string) DatabaseType + func ParseDatabaseTypeStrict(version string) (DatabaseType, error) + type EnvironmentConfig struct + AuthProxyCommand string + CloudRunFlags []string + EnvironmentVariables map[string]string + KubernetesServiceAccount string + SecretYAML string + SidecarYAML string + func GenerateEnvironmentConfig(method ConnectionMethod, computeType ComputeType, connectionName string, ...) EnvironmentConfig + type GCEInstanceInfo struct + ExternalIP string + HasExternalIP bool + InternalIP string + Name string + Project string + ServiceAccount string + Subnetwork string + VPCNetwork string + Zone string + func ExtractVMInfo(inst *compute.Instance, zone string) *GCEInstanceInfo + type GKEClusterInfo struct + Location string + Name string + PrivateCluster bool + Project string + Subnetwork string + VPCNative bool + VPCNetwork string + WorkloadIdentity bool + type Language string + const LangGo + const LangJava + const LangNodeJS + const LangPython + type SetupStep struct + Command string + Description string + Order int + Title string + func GenerateCloudRunSetupSteps(connectionName, serviceAccount, region string) []SetupStep + func GenerateGCESetupSteps(method ConnectionMethod, connectionName string, port int, privateIP string, ...) []SetupStep + func GenerateGKESetupSteps(connectionName string, port int, projectID string, namespace string) []SetupStep + func GenerateLocalSetupSteps(connectionName string, port int) []SetupStep + type ValidationCheck struct + Message string + Name string + Status string + type ValidationResult struct + Checks []ValidationCheck + Issues []string + Recommendations []string + Valid bool + func ValidateCloudRunConnection(sqlInfo *CloudSQLInstanceInfo, runInfo *CloudRunServiceInfo) *ValidationResult + func ValidateGCEConnection(sqlInfo *CloudSQLInstanceInfo, vmInfo *GCEInstanceInfo) *ValidationResult + func ValidateGKEConnection(sqlInfo *CloudSQLInstanceInfo, gkeInfo *GKEClusterInfo) *ValidationResult + func ValidateLocalConnection(sqlInfo *CloudSQLInstanceInfo) *ValidationResult
Go to main page