timeline

package
v1.7.9 Latest Latest
Warning

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

 Go to latest Published: Aug 2, 2023 License: Apache-2.0 Imports: 7 Imported by: 2

README

timeline

timeline is a package that provides functionality for easily implementing social scene application such as IM app, feed stream app.

timeline is based on TableStore timeline model.

Installation

$ go get github.com/aliyun/aliyun-tablestore-go-sdk

Sample

  • im application demo:
$ cd timeline/sample/im
$ go run main.go im.go
  • feed stream demo:
$ cd timeline/sample/feed
$ go run main.go feed.go

Benchmark

VM OS: Aliyun Linux 17.1 64bit

VM Configuration: 4 CPU, 8 GB RAM.

GO VERSION: 1.10.3 linux/amd64

Timeline Message Size: almost 220 bytes

  • on TableStore SSD High-performance instance
$ cd timeline
$ go test -bench=. -benchtime=10s -test.cpu=12
goos: linux
goarch: amd64
pkg: github.com/aliyun/aliyun-tablestore-go-sdk/timeline
BenchmarkTmLine_BatchStore_Concurrent-12                       	   10000	   1737993 ns/op
BenchmarkTmLine_BatchStore_WriteSpread-12                      	     100	 127729883 ns/op
BenchmarkTmLine_BatchStore_WriteSpread_IgnoreMessageLost-12    	     200	  80166859 ns/op
PASS
  • on TableStore Capacity instance
$ cd timeline
$ go test -bench=. -benchtime=10s -test.cpu=12
goos: linux
goarch: amd64
pkg: github.com/aliyun/aliyun-tablestore-go-sdk/timeline
BenchmarkTmLine_BatchStore_Concurrent-12                       	   10000	   1791522 ns/op
BenchmarkTmLine_BatchStore_WriteSpread-12                      	     100	 124597783 ns/op
BenchmarkTmLine_BatchStore_WriteSpread_IgnoreMessageLost-12    	     200	  83780501 ns/op

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrMisuse     = errors.New("misuse")
	ErrUnexpected = errors.New("unexpected")
	ErrorDone     = errors.New("done")
)
View Source 
var (
	DefaultFirstPk  = "TimelineId"
	DefaultSecondPk = "Sequence"

	MinTTL = 86400
)
View Source 
var DefaultStreamAdapter = &StreamMessageAdapter{
	IdKey:        "Id",
	ContentKey:   "Content",
	TimestampKey: "Timestamp",
	AttrPrefix:   "Attr_",
}

Functions

This section is empty.

Types

type Api 

type Api interface {
	Store(message Message) (int64, error)
	BatchStore(message Message) (*promise.Future, error)
	Update(sequenceId int64, message Message) error
	Load(sequenceId int64) (Message, error)
	Delete(sequenceId int64) error
	Scan(param *ScanParameter) *Iterator
}

type ColumnMap 

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

func FromMap 

func FromMap(mm map[string]interface{}) *ColumnMap

func LoadColumnMap 

func LoadColumnMap(attrs []*tablestore.AttributeColumn) *ColumnMap

func NewColumnMap 

func NewColumnMap() *ColumnMap

func (*ColumnMap) AddAnyColumn 

func (cm *ColumnMap) AddAnyColumn(key string, val interface{})

func (*ColumnMap) AddBoolColumn 

func (cm *ColumnMap) AddBoolColumn(key string, val bool)

func (*ColumnMap) AddBytesColumn 

func (cm *ColumnMap) AddBytesColumn(key string, val []byte)

func (*ColumnMap) AddFloat64Column 

func (cm *ColumnMap) AddFloat64Column(key string, val float64)

func (*ColumnMap) AddInt64Column 

func (cm *ColumnMap) AddInt64Column(key string, val int64)

func (*ColumnMap) AddStringColumn 

func (cm *ColumnMap) AddStringColumn(key string, val string)

func (*ColumnMap) GetInt64Column 

func (cm *ColumnMap) GetInt64Column(key string) int64

func (*ColumnMap) GetStringColumn 

func (cm *ColumnMap) GetStringColumn(key string) string

func (*ColumnMap) ToMap 

func (cm *ColumnMap) ToMap() map[string]interface{}

type DefaultStore 

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

func (*DefaultStore) BatchStore 

func (s *DefaultStore) BatchStore(id string, cols *ColumnMap) *promise.Future

func (*DefaultStore) Close 

func (s *DefaultStore) Close()

func (*DefaultStore) Delete 

func (s *DefaultStore) Delete(id string, seq int64) error

func (*DefaultStore) Load 

func (s *DefaultStore) Load(id string, seq int64) (*ColumnMap, error)

func (*DefaultStore) Scan 

func (s *DefaultStore) Scan(id string, param *ScanParameter) (map[int64]*ColumnMap, int64, error)

func (*DefaultStore) SequentialScan 

func (s *DefaultStore) SequentialScan(id string, param *ScanParameter) ([]*SequentialMessage, int64, error)

func (*DefaultStore) Store 

func (s *DefaultStore) Store(id string, cols *ColumnMap) (int64, error)

func (*DefaultStore) Sync 

func (s *DefaultStore) Sync() error

func (*DefaultStore) Update 

func (s *DefaultStore) Update(id string, seq int64, cols *ColumnMap) error

type Entry 

type Entry struct {
	Sequence int64
	Message  Message
}

type Iterator 

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

func NewIterator 

func NewIterator(retCh chan *Entry, errCh chan error) (*Iterator, context.Context)

func (*Iterator) Close 

func (i *Iterator) Close()

func (*Iterator) Next 

func (i *Iterator) Next() (*Entry, error)

type Message 

type Message interface{}

type MessageAdapter 

type MessageAdapter interface {
	Marshal(msg Message) (*ColumnMap, error)
	Unmarshal(cols *ColumnMap) (Message, error)
}

type MessageStore 

type MessageStore interface {
	Sync() error
	Store(id string, cols *ColumnMap) (int64, error)
	BatchStore(id string, cols *ColumnMap) *promise.Future
	Update(id string, seq int64, cols *ColumnMap) error
	Load(id string, seq int64) (*ColumnMap, error)
	Delete(id string, seq int64) error
	// Deprecated: Use SequentialScan instead, which keeps data
	// sequential to support iterate from max to min and vice versa.
	// Scan lost all sequential detail, as it puts all sequence
	// number and data to map[int64]ColumnMap.
	Scan(id string, param *ScanParameter) (map[int64]*ColumnMap, int64, error)
	SequentialScan(id string, param *ScanParameter) ([]*SequentialMessage, int64, error)
	Close()
}

func NewDefaultStore 

func NewDefaultStore(option StoreOption) (MessageStore, error)

func NewMessageStore 

func NewMessageStore(client tablestore.TableStoreApi, option StoreOption) (MessageStore, error)

type ScanParameter 

type ScanParameter struct {
	From          int64
	To            int64
	MaxCount      int
	IsForward     bool
	ColToGet      []string
	Filter        tablestore.ColumnFilter
	BufChanSize   int
	ErrorChanSize int
}

type Schema 

type Schema struct {
	FirstPk  string
	SecondPk string
}

type SequentialMessage 

type SequentialMessage struct {
	Sequence int64
	Column   *ColumnMap
}

type StoreOption 

type StoreOption struct {
	Endpoint      string
	Instance      string
	TableName     string
	AkId          string
	AkSecret      string
	SecurityToken string

	Schema     *Schema
	TTL        int
	Throughput *tablestore.ReservedThroughput

	TableStoreConfig *tablestore.TableStoreConfig
	WriterConfig     *writer.Config
}

type StreamMessage 

type StreamMessage struct {
	Id        string
	Content   interface{}
	Timestamp int64
	Attr      map[string]interface{}
}

type StreamMessageAdapter 

type StreamMessageAdapter struct {
	IdKey        string
	ContentKey   string
	TimestampKey string
	AttrPrefix   string
}

func (*StreamMessageAdapter) Marshal 

func (s *StreamMessageAdapter) Marshal(msg Message) (*ColumnMap, error)

func (*StreamMessageAdapter) Unmarshal 

func (s *StreamMessageAdapter) Unmarshal(cols *ColumnMap) (Message, error)

type TmLine 

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

func NewTmLine 

func NewTmLine(id string, adapter MessageAdapter, store MessageStore) (*TmLine, error)

func (*TmLine) BatchStore 

func (l *TmLine) BatchStore(message Message) (*promise.Future, error)

func (*TmLine) Delete 

func (l *TmLine) Delete(sequenceId int64) error

func (*TmLine) Load 

func (l *TmLine) Load(sequenceId int64) (Message, error)

func (*TmLine) Scan 

func (l *TmLine) Scan(param *ScanParameter) *Iterator

func (*TmLine) Store 

func (l *TmLine) Store(message Message) (int64, error)

func (*TmLine) Update 

func (l *TmLine) Update(sequenceId int64, message Message) error

Source Files

View all Source files

Directories

Path Synopsis
sample
feed
im

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.