docs

package

v4.99.0 Latest Latest Go to latest Published: Oct 19, 2026 License: MPL-2.0 Imports: 17 Imported by: 11

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudquery/plugin-sdk

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
func DefaultTitleTransformer(table *schema.Table) string
func TableOptionsDescriptionTransformer(tableOptions any, jsonSchema string) (schema.Transform, error)
type Format
- func FormatFromString(s string) (Format, error)
- func (r Format) String() string
type Generator
- func NewGenerator(pluginName string, tables schema.Tables) *Generator
- func (g *Generator) Generate(dir string, format Format) error
- func (g *Generator) GenerateJSON(dir string, format Format) error

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultTitleExceptions = map[string]string{

	"acl":   "ACL",
	"acls":  "ACLs",
	"api":   "API",
	"apis":  "APIs",
	"ca":    "CA",
	"cidr":  "CIDR",
	"cidrs": "CIDRs",
	"db":    "DB",
	"dbs":   "DBs",
	"dhcp":  "DHCP",
	"iam":   "IAM",
	"iot":   "IOT",
	"ip":    "IP",
	"ips":   "IPs",
	"ipv4":  "IPv4",
	"ipv6":  "IPv6",
	"mfa":   "MFA",
	"ml":    "ML",
	"oauth": "OAuth",
	"vpc":   "VPC",
	"vpcs":  "VPCs",
	"vpn":   "VPN",
	"vpns":  "VPNs",
	"waf":   "WAF",
	"wafs":  "WAFs",

	"aws": "AWS",
	"gcp": "GCP",
}

Functions ¶

func DefaultTitleTransformer ¶

func DefaultTitleTransformer(table *schema.Table) string

func TableOptionsDescriptionTransformer ¶ added in v4.79.0

func TableOptionsDescriptionTransformer(tableOptions any, jsonSchema string) (schema.Transform, error)

Types ¶

type Format ¶

type Format int

const (
	FormatMarkdown Format = iota
	FormatJSON
)

func FormatFromString ¶

func FormatFromString(s string) (Format, error)

func (Format) String ¶

func (r Format) String() string

type Generator ¶

type Generator struct {
	// contains filtered or unexported fields
}

func NewGenerator ¶

func NewGenerator(pluginName string, tables schema.Tables) *Generator

NewGenerator creates a new generator for the given tables. The tables are sorted by name. pluginName is optional and is used in markdown only

func (*Generator) Generate ¶

func (g *Generator) Generate(dir string, format Format) error

func (*Generator) GenerateJSON ¶ added in v4.81.0

func (g *Generator) GenerateJSON(dir string, format Format) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL