Skip to content

Common Types

Common suggested link types that release authors should conform to if type is used.


database type

link('...').address returns database address.

  • adapter [String]: Name of the adapter.
  • port [Integer]: Port to connect on.
  • tls [Hash]: See TLS properties
  • username [String]: Database username to use. Example: u387455.
  • password [String]: Database password to use.
  • database [String]: Database name. Example: app-server
  • options [Hash, optional]: Opaque set of options for the adapter. Example: {max_connections: 32, pool_timeout: 10}.

blobstore type

link('...').address returns blobstore address.

  • adapter [String]: Name of the adapter (s3, gcp, etc.).
  • tls [Hash]: See TLS properties
  • options [Hash, optional]: Opaque set of options. Example: {aws_access_key: ..., secret_access_key: ...}.