d1

package
v3.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type D1 

type D1 struct {
	// Specifies the timestamp the resource was created as an ISO8601 string.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// The D1 database's size, in bytes.
	FileSize  float64 `json:"file_size"`
	Name      string  `json:"name"`
	NumTables float64 `json:"num_tables"`
	UUID      string  `json:"uuid"`
	Version   string  `json:"version"`
	JSON      d1JSON  `json:"-"`
}

func (*D1) UnmarshalJSON 

func (r *D1) UnmarshalJSON(data []byte) (err error)

type D1Service 

type D1Service struct {
	Options  []option.RequestOption
	Database *DatabaseService
}

D1Service contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewD1Service method instead.

func NewD1Service 

func NewD1Service(opts ...option.RequestOption) (r *D1Service)

NewD1Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type DatabaseDeleteParams 

type DatabaseDeleteParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type DatabaseDeleteResponse 

type DatabaseDeleteResponse = interface{}

type DatabaseDeleteResponseEnvelope 

type DatabaseDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo  `json:"errors,required"`
	Messages []shared.ResponseInfo  `json:"messages,required"`
	Result   DatabaseDeleteResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success DatabaseDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseDeleteResponseEnvelope) UnmarshalJSON 

func (r *DatabaseDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseDeleteResponseEnvelopeSuccess 

type DatabaseDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseDeleteResponseEnvelopeSuccessTrue DatabaseDeleteResponseEnvelopeSuccess = true
)

func (DatabaseDeleteResponseEnvelopeSuccess) IsKnown 

func (r DatabaseDeleteResponseEnvelopeSuccess) IsKnown() bool

type DatabaseExportParams 

type DatabaseExportParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specifies that you will poll this endpoint until the export completes
	OutputFormat param.Field[DatabaseExportParamsOutputFormat] `json:"output_format,required"`
	// To poll an in-progress export, provide the current bookmark (returned by your
	// first polling response)
	CurrentBookmark param.Field[string]                          `json:"current_bookmark"`
	DumpOptions     param.Field[DatabaseExportParamsDumpOptions] `json:"dump_options"`
}

func (DatabaseExportParams) MarshalJSON 

func (r DatabaseExportParams) MarshalJSON() (data []byte, err error)

type DatabaseExportParamsDumpOptions 

type DatabaseExportParamsDumpOptions struct {
	// Export only the table definitions, not their contents
	NoData param.Field[bool] `json:"no_data"`
	// Export only each table's contents, not its definition
	NoSchema param.Field[bool] `json:"no_schema"`
	// Filter the export to just one or more tables. Passing an empty array is the same
	// as not passing anything and means: export all tables.
	Tables param.Field[[]string] `json:"tables"`
}

func (DatabaseExportParamsDumpOptions) MarshalJSON 

func (r DatabaseExportParamsDumpOptions) MarshalJSON() (data []byte, err error)

type DatabaseExportParamsOutputFormat 

type DatabaseExportParamsOutputFormat string

Specifies that you will poll this endpoint until the export completes 

const (
	DatabaseExportParamsOutputFormatPolling DatabaseExportParamsOutputFormat = "polling"
)

func (DatabaseExportParamsOutputFormat) IsKnown 

func (r DatabaseExportParamsOutputFormat) IsKnown() bool

type DatabaseExportResponse 

type DatabaseExportResponse struct {
	// The current time-travel bookmark for your D1, used to poll for updates. Will not
	// change for the duration of the export task.
	AtBookmark string `json:"at_bookmark"`
	// Only present when status = 'error'. Contains the error message.
	Error string `json:"error"`
	// Logs since the last time you polled
	Messages []string `json:"messages"`
	// Only present when status = 'complete'
	Result  DatabaseExportResponseResult `json:"result"`
	Status  DatabaseExportResponseStatus `json:"status"`
	Success bool                         `json:"success"`
	Type    DatabaseExportResponseType   `json:"type"`
	JSON    databaseExportResponseJSON   `json:"-"`
}

func (*DatabaseExportResponse) UnmarshalJSON 

func (r *DatabaseExportResponse) UnmarshalJSON(data []byte) (err error)

type DatabaseExportResponseEnvelope 

type DatabaseExportResponseEnvelope struct {
	Errors   []shared.ResponseInfo  `json:"errors,required"`
	Messages []shared.ResponseInfo  `json:"messages,required"`
	Result   DatabaseExportResponse `json:"result,required"`
	// Whether the API call was successful
	Success DatabaseExportResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseExportResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseExportResponseEnvelope) UnmarshalJSON 

func (r *DatabaseExportResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseExportResponseEnvelopeSuccess 

type DatabaseExportResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseExportResponseEnvelopeSuccessTrue DatabaseExportResponseEnvelopeSuccess = true
)

func (DatabaseExportResponseEnvelopeSuccess) IsKnown 

func (r DatabaseExportResponseEnvelopeSuccess) IsKnown() bool

type DatabaseExportResponseResult 

type DatabaseExportResponseResult struct {
	// The generated SQL filename.
	Filename string `json:"filename"`
	// The URL to download the exported SQL. Available for one hour.
	SignedURL string                           `json:"signed_url"`
	JSON      databaseExportResponseResultJSON `json:"-"`
}

Only present when status = 'complete'

func (*DatabaseExportResponseResult) UnmarshalJSON 

func (r *DatabaseExportResponseResult) UnmarshalJSON(data []byte) (err error)

type DatabaseExportResponseStatus 

type DatabaseExportResponseStatus string
const (
	DatabaseExportResponseStatusComplete DatabaseExportResponseStatus = "complete"
	DatabaseExportResponseStatusError    DatabaseExportResponseStatus = "error"
)

func (DatabaseExportResponseStatus) IsKnown 

func (r DatabaseExportResponseStatus) IsKnown() bool

type DatabaseExportResponseType 

type DatabaseExportResponseType string
const (
	DatabaseExportResponseTypeExport DatabaseExportResponseType = "export"
)

func (DatabaseExportResponseType) IsKnown 

func (r DatabaseExportResponseType) IsKnown() bool

type DatabaseGetParams 

type DatabaseGetParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
}

type DatabaseGetResponseEnvelope 

type DatabaseGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   D1                    `json:"result,required"`
	// Whether the API call was successful
	Success DatabaseGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseGetResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseGetResponseEnvelope) UnmarshalJSON 

func (r *DatabaseGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseGetResponseEnvelopeSuccess 

type DatabaseGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseGetResponseEnvelopeSuccessTrue DatabaseGetResponseEnvelopeSuccess = true
)

func (DatabaseGetResponseEnvelopeSuccess) IsKnown 

func (r DatabaseGetResponseEnvelopeSuccess) IsKnown() bool

type DatabaseImportParams 

type DatabaseImportParams struct {
	// Account identifier tag.
	AccountID param.Field[string]           `path:"account_id,required"`
	Body      DatabaseImportParamsBodyUnion `json:"body,required"`
}

func (DatabaseImportParams) MarshalJSON 

func (r DatabaseImportParams) MarshalJSON() (data []byte, err error)

type DatabaseImportParamsBody 

type DatabaseImportParamsBody struct {
	// Indicates you have a new SQL file to upload.
	Action param.Field[DatabaseImportParamsBodyAction] `json:"action,required"`
	// Required when action is 'init' or 'ingest'. An md5 hash of the file you're
	// uploading. Used to check if it already exists, and validate its contents before
	// ingesting.
	Etag param.Field[string] `json:"etag"`
	// The filename you have successfully uploaded.
	Filename param.Field[string] `json:"filename"`
	// This identifies the currently-running import, checking its status.
	CurrentBookmark param.Field[string] `json:"current_bookmark"`
}

func (DatabaseImportParamsBody) MarshalJSON 

func (r DatabaseImportParamsBody) MarshalJSON() (data []byte, err error)

type DatabaseImportParamsBodyAction 

type DatabaseImportParamsBodyAction string

Indicates you have a new SQL file to upload. 

const (
	DatabaseImportParamsBodyActionInit   DatabaseImportParamsBodyAction = "init"
	DatabaseImportParamsBodyActionIngest DatabaseImportParamsBodyAction = "ingest"
	DatabaseImportParamsBodyActionPoll   DatabaseImportParamsBodyAction = "poll"
)

func (DatabaseImportParamsBodyAction) IsKnown 

func (r DatabaseImportParamsBodyAction) IsKnown() bool

type DatabaseImportParamsBodyObject 

type DatabaseImportParamsBodyObject struct {
	// Indicates you have a new SQL file to upload.
	Action param.Field[DatabaseImportParamsBodyObjectAction] `json:"action,required"`
	// Required when action is 'init' or 'ingest'. An md5 hash of the file you're
	// uploading. Used to check if it already exists, and validate its contents before
	// ingesting.
	Etag param.Field[string] `json:"etag,required"`
}

func (DatabaseImportParamsBodyObject) MarshalJSON 

func (r DatabaseImportParamsBodyObject) MarshalJSON() (data []byte, err error)

type DatabaseImportParamsBodyObjectAction 

type DatabaseImportParamsBodyObjectAction string

Indicates you have a new SQL file to upload. 

const (
	DatabaseImportParamsBodyObjectActionInit DatabaseImportParamsBodyObjectAction = "init"
)

func (DatabaseImportParamsBodyObjectAction) IsKnown 

func (r DatabaseImportParamsBodyObjectAction) IsKnown() bool

type DatabaseImportParamsBodyUnion 

type DatabaseImportParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by d1.DatabaseImportParamsBodyObject, d1.DatabaseImportParamsBodyObject, d1.DatabaseImportParamsBodyObject, DatabaseImportParamsBody.

type DatabaseImportResponse 

type DatabaseImportResponse struct {
	// The current time-travel bookmark for your D1, used to poll for updates. Will not
	// change for the duration of the import. Only returned if an import process is
	// currently running or recently finished.
	AtBookmark string `json:"at_bookmark"`
	// Only present when status = 'error'. Contains the error message that prevented
	// the import from succeeding.
	Error string `json:"error"`
	// Derived from the database ID and etag, to use in avoiding repeated uploads. Only
	// returned when for the 'init' action.
	Filename string `json:"filename"`
	// Logs since the last time you polled
	Messages []string `json:"messages"`
	// Only present when status = 'complete'
	Result  DatabaseImportResponseResult `json:"result"`
	Status  DatabaseImportResponseStatus `json:"status"`
	Success bool                         `json:"success"`
	Type    DatabaseImportResponseType   `json:"type"`
	// The R2 presigned URL to use for uploading. Only returned when for the 'init'
	// action.
	UploadURL string                     `json:"upload_url"`
	JSON      databaseImportResponseJSON `json:"-"`
}

func (*DatabaseImportResponse) UnmarshalJSON 

func (r *DatabaseImportResponse) UnmarshalJSON(data []byte) (err error)

type DatabaseImportResponseEnvelope 

type DatabaseImportResponseEnvelope struct {
	Errors   []shared.ResponseInfo  `json:"errors,required"`
	Messages []shared.ResponseInfo  `json:"messages,required"`
	Result   DatabaseImportResponse `json:"result,required"`
	// Whether the API call was successful
	Success DatabaseImportResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseImportResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseImportResponseEnvelope) UnmarshalJSON 

func (r *DatabaseImportResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseImportResponseEnvelopeSuccess 

type DatabaseImportResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseImportResponseEnvelopeSuccessTrue DatabaseImportResponseEnvelopeSuccess = true
)

func (DatabaseImportResponseEnvelopeSuccess) IsKnown 

func (r DatabaseImportResponseEnvelopeSuccess) IsKnown() bool

type DatabaseImportResponseResult 

type DatabaseImportResponseResult struct {
	// The time-travel bookmark if you need restore your D1 to directly after the
	// import succeeded.
	FinalBookmark string                           `json:"final_bookmark"`
	Meta          DatabaseImportResponseResultMeta `json:"meta"`
	// The total number of queries that were executed during the import.
	NumQueries float64                          `json:"num_queries"`
	JSON       databaseImportResponseResultJSON `json:"-"`
}

Only present when status = 'complete'

func (*DatabaseImportResponseResult) UnmarshalJSON 

func (r *DatabaseImportResponseResult) UnmarshalJSON(data []byte) (err error)

type DatabaseImportResponseResultMeta 

type DatabaseImportResponseResultMeta struct {
	ChangedDB   bool                                 `json:"changed_db"`
	Changes     float64                              `json:"changes"`
	Duration    float64                              `json:"duration"`
	LastRowID   float64                              `json:"last_row_id"`
	RowsRead    float64                              `json:"rows_read"`
	RowsWritten float64                              `json:"rows_written"`
	SizeAfter   float64                              `json:"size_after"`
	JSON        databaseImportResponseResultMetaJSON `json:"-"`
}

func (*DatabaseImportResponseResultMeta) UnmarshalJSON 

func (r *DatabaseImportResponseResultMeta) UnmarshalJSON(data []byte) (err error)

type DatabaseImportResponseStatus 

type DatabaseImportResponseStatus string
const (
	DatabaseImportResponseStatusComplete DatabaseImportResponseStatus = "complete"
	DatabaseImportResponseStatusError    DatabaseImportResponseStatus = "error"
)

func (DatabaseImportResponseStatus) IsKnown 

func (r DatabaseImportResponseStatus) IsKnown() bool

type DatabaseImportResponseType 

type DatabaseImportResponseType string
const (
	DatabaseImportResponseTypeImport DatabaseImportResponseType = "import"
)

func (DatabaseImportResponseType) IsKnown 

func (r DatabaseImportResponseType) IsKnown() bool

type DatabaseListParams 

type DatabaseListParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// a database name to search for.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of items per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (DatabaseListParams) URLQuery 

func (r DatabaseListParams) URLQuery() (v url.Values)

URLQuery serializes DatabaseListParams's query parameters as `url.Values`.

type DatabaseListResponse 

type DatabaseListResponse struct {
	// Specifies the timestamp the resource was created as an ISO8601 string.
	CreatedAt time.Time                `json:"created_at" format:"date-time"`
	Name      string                   `json:"name"`
	UUID      string                   `json:"uuid"`
	Version   string                   `json:"version"`
	JSON      databaseListResponseJSON `json:"-"`
}

func (*DatabaseListResponse) UnmarshalJSON 

func (r *DatabaseListResponse) UnmarshalJSON(data []byte) (err error)

type DatabaseNewParams 

type DatabaseNewParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	Name      param.Field[string] `json:"name,required"`
	// Specify the region to create the D1 primary, if available. If this option is
	// omitted, the D1 will be created as close as possible to the current user.
	PrimaryLocationHint param.Field[DatabaseNewParamsPrimaryLocationHint] `json:"primary_location_hint"`
}

func (DatabaseNewParams) MarshalJSON 

func (r DatabaseNewParams) MarshalJSON() (data []byte, err error)

type DatabaseNewParamsPrimaryLocationHint 

type DatabaseNewParamsPrimaryLocationHint string

Specify the region to create the D1 primary, if available. If this option is omitted, the D1 will be created as close as possible to the current user. 

const (
	DatabaseNewParamsPrimaryLocationHintWnam DatabaseNewParamsPrimaryLocationHint = "wnam"
	DatabaseNewParamsPrimaryLocationHintEnam DatabaseNewParamsPrimaryLocationHint = "enam"
	DatabaseNewParamsPrimaryLocationHintWeur DatabaseNewParamsPrimaryLocationHint = "weur"
	DatabaseNewParamsPrimaryLocationHintEeur DatabaseNewParamsPrimaryLocationHint = "eeur"
	DatabaseNewParamsPrimaryLocationHintApac DatabaseNewParamsPrimaryLocationHint = "apac"
	DatabaseNewParamsPrimaryLocationHintOc   DatabaseNewParamsPrimaryLocationHint = "oc"
)

func (DatabaseNewParamsPrimaryLocationHint) IsKnown 

func (r DatabaseNewParamsPrimaryLocationHint) IsKnown() bool

type DatabaseNewResponseEnvelope 

type DatabaseNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   D1                    `json:"result,required"`
	// Whether the API call was successful
	Success DatabaseNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseNewResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseNewResponseEnvelope) UnmarshalJSON 

func (r *DatabaseNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseNewResponseEnvelopeSuccess 

type DatabaseNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseNewResponseEnvelopeSuccessTrue DatabaseNewResponseEnvelopeSuccess = true
)

func (DatabaseNewResponseEnvelopeSuccess) IsKnown 

func (r DatabaseNewResponseEnvelopeSuccess) IsKnown() bool

type DatabaseQueryParams 

type DatabaseQueryParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Your SQL query. Supports multiple statements, joined by semicolons, which will
	// be executed as a batch.
	Sql    param.Field[string]   `json:"sql,required"`
	Params param.Field[[]string] `json:"params"`
}

func (DatabaseQueryParams) MarshalJSON 

func (r DatabaseQueryParams) MarshalJSON() (data []byte, err error)

type DatabaseQueryResponseEnvelope 

type DatabaseQueryResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   []QueryResult         `json:"result,required"`
	// Whether the API call was successful
	Success DatabaseQueryResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseQueryResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseQueryResponseEnvelope) UnmarshalJSON 

func (r *DatabaseQueryResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseQueryResponseEnvelopeSuccess 

type DatabaseQueryResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseQueryResponseEnvelopeSuccessTrue DatabaseQueryResponseEnvelopeSuccess = true
)

func (DatabaseQueryResponseEnvelopeSuccess) IsKnown 

func (r DatabaseQueryResponseEnvelopeSuccess) IsKnown() bool

type DatabaseRawParams 

type DatabaseRawParams struct {
	// Account identifier tag.
	AccountID param.Field[string] `path:"account_id,required"`
	// Your SQL query. Supports multiple statements, joined by semicolons, which will
	// be executed as a batch.
	Sql    param.Field[string]   `json:"sql,required"`
	Params param.Field[[]string] `json:"params"`
}

func (DatabaseRawParams) MarshalJSON 

func (r DatabaseRawParams) MarshalJSON() (data []byte, err error)

type DatabaseRawResponse 

type DatabaseRawResponse struct {
	Meta    DatabaseRawResponseMeta    `json:"meta"`
	Results DatabaseRawResponseResults `json:"results"`
	Success bool                       `json:"success"`
	JSON    databaseRawResponseJSON    `json:"-"`
}

func (*DatabaseRawResponse) UnmarshalJSON 

func (r *DatabaseRawResponse) UnmarshalJSON(data []byte) (err error)

type DatabaseRawResponseEnvelope 

type DatabaseRawResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   []DatabaseRawResponse `json:"result,required"`
	// Whether the API call was successful
	Success DatabaseRawResponseEnvelopeSuccess `json:"success,required"`
	JSON    databaseRawResponseEnvelopeJSON    `json:"-"`
}

func (*DatabaseRawResponseEnvelope) UnmarshalJSON 

func (r *DatabaseRawResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type DatabaseRawResponseEnvelopeSuccess 

type DatabaseRawResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	DatabaseRawResponseEnvelopeSuccessTrue DatabaseRawResponseEnvelopeSuccess = true
)

func (DatabaseRawResponseEnvelopeSuccess) IsKnown 

func (r DatabaseRawResponseEnvelopeSuccess) IsKnown() bool

type DatabaseRawResponseMeta 

type DatabaseRawResponseMeta struct {
	ChangedDB   bool                        `json:"changed_db"`
	Changes     float64                     `json:"changes"`
	Duration    float64                     `json:"duration"`
	LastRowID   float64                     `json:"last_row_id"`
	RowsRead    float64                     `json:"rows_read"`
	RowsWritten float64                     `json:"rows_written"`
	SizeAfter   float64                     `json:"size_after"`
	JSON        databaseRawResponseMetaJSON `json:"-"`
}

func (*DatabaseRawResponseMeta) UnmarshalJSON 

func (r *DatabaseRawResponseMeta) UnmarshalJSON(data []byte) (err error)

type DatabaseRawResponseResults 

type DatabaseRawResponseResults struct {
	Columns []string                       `json:"columns"`
	Rows    [][]interface{}                `json:"rows"`
	JSON    databaseRawResponseResultsJSON `json:"-"`
}

func (*DatabaseRawResponseResults) UnmarshalJSON 

func (r *DatabaseRawResponseResults) UnmarshalJSON(data []byte) (err error)

type DatabaseService 

type DatabaseService struct {
	Options []option.RequestOption
}

DatabaseService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDatabaseService method instead.

func NewDatabaseService 

func NewDatabaseService(opts ...option.RequestOption) (r *DatabaseService)

NewDatabaseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*DatabaseService) Delete 

func (r *DatabaseService) Delete(ctx context.Context, databaseID string, body DatabaseDeleteParams, opts ...option.RequestOption) (res *DatabaseDeleteResponse, err error)

Deletes the specified D1 database.

func (*DatabaseService) Export 

func (r *DatabaseService) Export(ctx context.Context, databaseID string, params DatabaseExportParams, opts ...option.RequestOption) (res *DatabaseExportResponse, err error)

Returns a URL where the SQL contents of your D1 can be downloaded. Note: this process may take some time for larger DBs, during which your D1 will be unavailable to serve queries. To avoid blocking your DB unnecessarily, an in-progress export must be continually polled or will automatically cancel.

func (*DatabaseService) Get 

func (r *DatabaseService) Get(ctx context.Context, databaseID string, query DatabaseGetParams, opts ...option.RequestOption) (res *D1, err error)

Returns the specified D1 database.

func (*DatabaseService) Import 

func (r *DatabaseService) Import(ctx context.Context, databaseID string, params DatabaseImportParams, opts ...option.RequestOption) (res *DatabaseImportResponse, err error)

Generates a temporary URL for uploading an SQL file to, then instructing the D1 to import it and polling it for status updates. Imports block the D1 for their duration.

func (*DatabaseService) List 

func (r *DatabaseService) List(ctx context.Context, params DatabaseListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[DatabaseListResponse], err error)

Returns a list of D1 databases.

func (*DatabaseService) ListAutoPaging 

func (r *DatabaseService) ListAutoPaging(ctx context.Context, params DatabaseListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[DatabaseListResponse]

Returns a list of D1 databases.

func (*DatabaseService) New 

func (r *DatabaseService) New(ctx context.Context, params DatabaseNewParams, opts ...option.RequestOption) (res *D1, err error)

Returns the created D1 database.

func (*DatabaseService) Query 

func (r *DatabaseService) Query(ctx context.Context, databaseID string, params DatabaseQueryParams, opts ...option.RequestOption) (res *[]QueryResult, err error)

Returns the query result as an object.

func (*DatabaseService) Raw 

func (r *DatabaseService) Raw(ctx context.Context, databaseID string, params DatabaseRawParams, opts ...option.RequestOption) (res *[]DatabaseRawResponse, err error)

Returns the query result rows as arrays rather than objects. This is a performance-optimized version of the /query endpoint.

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam 

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRoleParam 

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissionsParam 

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUserParam 

type MemberUserParam = shared.MemberUserParam

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type QueryResult 

type QueryResult struct {
	Meta    QueryResultMeta `json:"meta"`
	Results []interface{}   `json:"results"`
	Success bool            `json:"success"`
	JSON    queryResultJSON `json:"-"`
}

func (*QueryResult) UnmarshalJSON 

func (r *QueryResult) UnmarshalJSON(data []byte) (err error)

type QueryResultMeta 

type QueryResultMeta struct {
	ChangedDB   bool                `json:"changed_db"`
	Changes     float64             `json:"changes"`
	Duration    float64             `json:"duration"`
	LastRowID   float64             `json:"last_row_id"`
	RowsRead    float64             `json:"rows_read"`
	RowsWritten float64             `json:"rows_written"`
	SizeAfter   float64             `json:"size_after"`
	JSON        queryResultMetaJSON `json:"-"`
}

func (*QueryResultMeta) UnmarshalJSON 

func (r *QueryResultMeta) UnmarshalJSON(data []byte) (err error)

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.