chainbase

Documentation

Index

• Constants
• type Client
  • func NewClient(options ...ClientOption) (*Client, error)
  • func (c *Client) Do(_ context.Context, request *http.Request, value any) (*http.Response, error)
  • func (c *Client) NewRequest(ctx context.Context, method string, reference string, body any) (*http.Request, error)
• type ClientOption
  • func WithAPIKey(apiKey string) ClientOption
• type DataWarehouseData
• type DataWarehouseDataMeta
• type DataWarehouseService
  • func (s *DataWarehouseService) Paginate(ctx context.Context, taskID string, page int) (*Response[*DataWarehouseData], *http.Response, error)
  • func (s *DataWarehouseService) Query(ctx context.Context, query string) (*Response[*DataWarehouseData], *http.Response, error)
• type Response

Constants

const (
	DefaultBaseURL   = "https://api.chainbase.online/"
	DefaultAPIKey    = "demo"
	DefaultUserAgent = "chainbase-grafana"
)

const (
	CodeOK = 0
)

Types

type Client

type Client struct {
	BaseURL   *url.URL
	UserAgent string
	APIKey    string

	DataWarehouse *DataWarehouseService
	// contains filtered or unexported fields
}

func NewClient

func NewClient(options ...ClientOption) (*Client, error)

func (*Client) Do

func (c *Client) Do(_ context.Context, request *http.Request, value any) (*http.Response, error)

func (*Client) NewRequest

func (c *Client) NewRequest(ctx context.Context, method string, reference string, body any) (*http.Request, error)

type ClientOption

type ClientOption func(*Client) error

func WithAPIKey

func WithAPIKey(apiKey string) ClientOption

type DataWarehouseData

type DataWarehouseData struct {
	TaskID    string                  `json:"task_id"`
	Rows      int                     `json:"rows"`
	RowsRead  int                     `json:"rows_read"`
	BytesRead int                     `json:"bytes_read"`
	Elapsed   float32                 `json:"elapsed"`
	Meta      []DataWarehouseDataMeta `json:"meta"`
	Result    []map[string]any        `json:"result"`
	ErrMsg    string                  `json:"err_msg,omitempty"`
	NextPage  int                     `json:"next_page"`
}

type DataWarehouseDataMeta

type DataWarehouseDataMeta struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

type DataWarehouseService

type DataWarehouseService service

func (*DataWarehouseService) Paginate

func (s *DataWarehouseService) Paginate(ctx context.Context, taskID string, page int) (*Response[*DataWarehouseData], *http.Response, error)

func (*DataWarehouseService) Query

func (s *DataWarehouseService) Query(ctx context.Context, query string) (*Response[*DataWarehouseData], *http.Response, error)

type Response

type Response[T any] struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	Data    T      `json:"data"`
}