Documentation
¶
Index ¶
- Constants
- type Client
- type DatabaseCreateRequest
- type DatabaseCreateResponse
- type DatabaseDeleteRequest
- type DatabaseDeleteResponse
- type DatabaseRef
- type Document
- type DocumentCreateRequest
- type DocumentCreateResponse
- type DocumentDeleteRequest
- type DocumentDeleteResponse
- type DocumentFetchMetaRequest
- type DocumentFetchMetaResponse
- type DocumentFetchRequest
- type DocumentFetchResponse
- type DocumentRef
- func (dr *DocumentRef) Create(document Document) *DocumentCreateRequest
- func (dr *DocumentRef) Delete(id, revision string) *DocumentDeleteRequest
- func (dr *DocumentRef) Fetch(id string) *DocumentFetchRequest
- func (dr *DocumentRef) FetchMeta(id string) *DocumentFetchMetaRequest
- func (dr *DocumentRef) Update(id string, document Document) *DocumentUpdateRequest
- type DocumentUpdateRequest
- type DocumentUpdateResponse
Constants ¶
const ( MimeTypeTextPlain = "text/plain" MimeTypeJSON = "application/json" MimeTypeMultipartRelated = "multipart/related" MimeTypeOctetStream = "application/octet-stream" )
Some MIME types.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client implements a simple couch db client.
func (*Client) Database ¶
func (c *Client) Database(name string) *DatabaseRef
Database returns a reference to the database with the provided name.
type DatabaseCreateRequest ¶
type DatabaseCreateRequest struct {
// contains filtered or unexported fields
}
DatabaseCreateRequest defines the database create request.
func (*DatabaseCreateRequest) Do ¶
func (dcr *DatabaseCreateRequest) Do() (*DatabaseCreateResponse, error)
Do performs the request.
func (*DatabaseCreateRequest) WithContext ¶
func (dcr *DatabaseCreateRequest) WithContext(ctx context.Context) *DatabaseCreateRequest
WithContext adds a context to the request.
type DatabaseCreateResponse ¶
type DatabaseCreateResponse struct {
OK bool `json:"ok"`
Error string `json:"error"`
Reason string `json:"reason"`
}
DatabaseCreateResponse efines the database create response.
type DatabaseDeleteRequest ¶
type DatabaseDeleteRequest struct {
// contains filtered or unexported fields
}
DatabaseDeleteRequest defines the database delete request.
func (*DatabaseDeleteRequest) Do ¶
func (ddr *DatabaseDeleteRequest) Do() (*DatabaseDeleteResponse, error)
Do performs the request.
func (*DatabaseDeleteRequest) WithContext ¶
func (ddr *DatabaseDeleteRequest) WithContext(ctx context.Context) *DatabaseDeleteRequest
WithContext adds a context to the request.
type DatabaseDeleteResponse ¶
type DatabaseDeleteResponse struct {
OK bool `json:"ok"`
}
DatabaseDeleteResponse defines the database delete response.
type DatabaseRef ¶
type DatabaseRef struct {
// contains filtered or unexported fields
}
DatabaseRef holds the reference to a database.
func (*DatabaseRef) Create ¶
func (dr *DatabaseRef) Create() *DatabaseCreateRequest
Create returns the database create request.
func (*DatabaseRef) Delete ¶
func (dr *DatabaseRef) Delete() *DatabaseDeleteRequest
Delete returns the database delete request.
func (*DatabaseRef) Document ¶
func (dr *DatabaseRef) Document() *DocumentRef
Document returns a reference to a document in the database.
type DocumentCreateRequest ¶
type DocumentCreateRequest struct {
// contains filtered or unexported fields
}
DocumentCreateRequest defines the document create request.
func (*DocumentCreateRequest) Do ¶
func (dcr *DocumentCreateRequest) Do() (*DocumentCreateResponse, error)
Do performs the request.
func (*DocumentCreateRequest) WithContext ¶
func (dcr *DocumentCreateRequest) WithContext(ctx context.Context) *DocumentCreateRequest
WithContext adds a context to the request.
type DocumentCreateResponse ¶
type DocumentCreateResponse struct {
OK bool `json:"ok"`
ID string `json:"id"`
Revision string `json:"rev"`
}
DocumentCreateResponse defines the document create response.
type DocumentDeleteRequest ¶
type DocumentDeleteRequest struct {
// contains filtered or unexported fields
}
DocumentDeleteRequest defines the document fetch request.
func (*DocumentDeleteRequest) Do ¶
func (ddr *DocumentDeleteRequest) Do() (*DocumentDeleteResponse, error)
Do performs the request.
func (*DocumentDeleteRequest) WithContext ¶
func (ddr *DocumentDeleteRequest) WithContext(ctx context.Context) *DocumentDeleteRequest
WithContext adds a context to the request.
type DocumentDeleteResponse ¶
type DocumentDeleteResponse struct {
OK bool `json:"ok"`
ID string `json:"id"`
Revision string `json:"rev"`
}
DocumentDeleteResponse defines the document create response.
type DocumentFetchMetaRequest ¶
type DocumentFetchMetaRequest struct {
// contains filtered or unexported fields
}
DocumentFetchMetaRequest defines the document fetch request.
func (*DocumentFetchMetaRequest) Do ¶
func (dfr *DocumentFetchMetaRequest) Do() (*DocumentFetchMetaResponse, error)
Do performs the request.
func (*DocumentFetchMetaRequest) WithContext ¶
func (dfr *DocumentFetchMetaRequest) WithContext(ctx context.Context) *DocumentFetchMetaRequest
WithContext adds a context to the request.
func (*DocumentFetchMetaRequest) WithRevision ¶
func (dfr *DocumentFetchMetaRequest) WithRevision(revision string) *DocumentFetchMetaRequest
WithRevision adds a revision to the request.
type DocumentFetchMetaResponse ¶
DocumentFetchMetaResponse defines the document create response.
type DocumentFetchRequest ¶
type DocumentFetchRequest struct {
// contains filtered or unexported fields
}
DocumentFetchRequest defines the document fetch request.
func (*DocumentFetchRequest) Do ¶
func (dfr *DocumentFetchRequest) Do() (*DocumentFetchResponse, error)
Do performs the request.
func (*DocumentFetchRequest) WithContext ¶
func (dfr *DocumentFetchRequest) WithContext(ctx context.Context) *DocumentFetchRequest
WithContext adds a context to the request.
func (*DocumentFetchRequest) WithRevision ¶
func (dfr *DocumentFetchRequest) WithRevision(revision string) *DocumentFetchRequest
WithRevision adds a revision to the request.
type DocumentFetchResponse ¶
DocumentFetchResponse defines the document create response.
type DocumentRef ¶
type DocumentRef struct {
// contains filtered or unexported fields
}
DocumentRef holds the reference to a document.
func (*DocumentRef) Create ¶
func (dr *DocumentRef) Create(document Document) *DocumentCreateRequest
Create returns the document create request.
func (*DocumentRef) Delete ¶
func (dr *DocumentRef) Delete(id, revision string) *DocumentDeleteRequest
Delete returns the document delete request.
func (*DocumentRef) Fetch ¶
func (dr *DocumentRef) Fetch(id string) *DocumentFetchRequest
Fetch returns the document fetch request.
func (*DocumentRef) FetchMeta ¶
func (dr *DocumentRef) FetchMeta(id string) *DocumentFetchMetaRequest
FetchMeta returns the document fetch meta request.
func (*DocumentRef) Update ¶
func (dr *DocumentRef) Update(id string, document Document) *DocumentUpdateRequest
Update returns the document update request.
type DocumentUpdateRequest ¶
type DocumentUpdateRequest struct {
// contains filtered or unexported fields
}
DocumentUpdateRequest defines the document create request.
func (*DocumentUpdateRequest) Do ¶
func (dur *DocumentUpdateRequest) Do() (*DocumentUpdateResponse, error)
Do performs the request.
func (*DocumentUpdateRequest) WithContext ¶
func (dur *DocumentUpdateRequest) WithContext(ctx context.Context) *DocumentUpdateRequest
WithContext adds a context to the request.
func (*DocumentUpdateRequest) WithRevision ¶
func (dur *DocumentUpdateRequest) WithRevision(revision string) *DocumentUpdateRequest
WithRevision adds a revision to the request.
type DocumentUpdateResponse ¶
type DocumentUpdateResponse struct {
OK bool `json:"ok"`
ID string `json:"id"`
Revision string `json:"rev"`
}
DocumentUpdateResponse defines the document create response.