describe_table

Documentation

Overview

Support for the DynamoDB DescribeTable endpoint.

example use:

tests/create_table-livestest.go, which contains a DescribeTable invocation

Index

• Constants
• func IsTableStatus(tablename string, status string) (bool, error)
• func IsTableStatusWithConf(tablename string, status string, c *conf.AWS_Conf) (bool, error)
• func PollTableStatus(tablename string, status string, tries int) (bool, error)
• func PollTableStatusWithConf(tablename string, status string, tries int, c *conf.AWS_Conf) (bool, error)
• type Describe
  • func (describe *Describe) EndpointReq() ([]byte, int, error)
  • func (describe *Describe) EndpointReqWithConf(c *conf.AWS_Conf) ([]byte, int, error)
• type DescribeTable
  • func NewDescribeTable() *DescribeTable
  • func (describe_table *DescribeTable) EndpointReq() ([]byte, int, error)
  • func (describe_table *DescribeTable) EndpointReqWithConf(c *conf.AWS_Conf) ([]byte, int, error)
  • func (desc DescribeTable) TableExists() (bool, error)
  • func (desc DescribeTable) TableExistsWithConf(c *conf.AWS_Conf) (bool, error)
• type Request
  • func (req *Request) EndpointReq() ([]byte, int, error)
  • func (req *Request) EndpointReqWithConf(c *conf.AWS_Conf) ([]byte, int, error)
• type Response
  • func NewResponse() *Response
• type StatusResult

Constants

const (
	ENDPOINT_NAME      = "DescribeTable"
	DESCTABLE_ENDPOINT = aws_const.ENDPOINT_PREFIX + ENDPOINT_NAME
	ACTIVE             = "ACTIVE"
)

Functions

func IsTableStatus

func IsTableStatus(tablename string, status string) (bool, error)

IsTableStatus is the same as IsTableStatusWithConf but uses the global conf.Vals.

func IsTableStatusWithConf

func IsTableStatusWithConf(tablename string, status string, c *conf.AWS_Conf) (bool, error)

IsTableStatusWithConf will test the equality status of a table.

func PollTableStatus

func PollTableStatus(tablename string, status string, tries int) (bool, error)

PollTableStatus is the same as PollTableStatusWithConf but uses the global conf.Vals.

func PollTableStatusWithConf

func PollTableStatusWithConf(tablename string, status string, tries int, c *conf.AWS_Conf) (bool, error)

PollTableStatusWithConf allows the caller to poll a table for a specific status.

Types

type Describe

type Describe DescribeTable

Describe is an alias for backwards compatibility

func (*Describe) EndpointReq

func (describe *Describe) EndpointReq() ([]byte, int, error)

func (*Describe) EndpointReqWithConf

func (describe *Describe) EndpointReqWithConf(c *conf.AWS_Conf) ([]byte, int, error)

type DescribeTable

type DescribeTable struct {
	TableName string
}

func NewDescribeTable

func NewDescribeTable() *DescribeTable

func (*DescribeTable) EndpointReq

func (describe_table *DescribeTable) EndpointReq() ([]byte, int, error)

func (*DescribeTable) EndpointReqWithConf

func (describe_table *DescribeTable) EndpointReqWithConf(c *conf.AWS_Conf) ([]byte, int, error)

func (DescribeTable) TableExists

func (desc DescribeTable) TableExists() (bool, error)

TableExists is the same as TableExistsWithConf but uses the global conf.Vals.

func (DescribeTable) TableExistsWithConf

func (desc DescribeTable) TableExistsWithConf(c *conf.AWS_Conf) (bool, error)

TableExistsWithconf test for table exists: exploit the fact that aws reports 4xx for tables that don't exist.

type Request

type Request DescribeTable

func (*Request) EndpointReq

func (req *Request) EndpointReq() ([]byte, int, error)

func (*Request) EndpointReqWithConf

func (req *Request) EndpointReqWithConf(c *conf.AWS_Conf) ([]byte, int, error)

type Response

type Response struct {
	Table struct {
		AttributeDefinitions   attributedefinition.AttributeDefinitions
		CreationDateTime       float64
		GlobalSecondaryIndexes []globalsecondaryindex.GlobalSecondaryIndexDesc
		ItemCount              uint64
		KeySchema              keydefinition.KeySchema
		LocalSecondaryIndexes  []localsecondaryindex.LocalSecondaryIndexDesc
		ProvisionedThroughput  provisionedthroughput.ProvisionedThroughputDesc
		TableName              string
		TableSizeBytes         uint64
		TableStatus            string
	}
}

func NewResponse

func NewResponse() *Response

type StatusResult

type StatusResult struct {
	StatusResult bool
}