lakefs_sdk

package module
v0.0.7 Latest Latest
Warning

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

Go to latest
Published: Feb 7, 2022 License: MIT Imports: 16 Imported by: 0

README

lakefs-sdk

lakefs golang sdk

use

go get github.com/dollarkillerx/lakefs-sdk

sdk list
  • Repositories
  • CreateRepositories
  • GetRepositories
  • DeleteRepositories
  • Branches
  • CreateBranch
  • GetBranch
  • DeleteBranch
  • CreateCommit
  • GetCommits
  • ListObject
  • GetObject
  • SetObjectMetaData
  • DeleteObject
  • GetObjectMetaData
  • GetObjectByPrefix
  • UploadObject
  • PutObject
  • UploadObjectAndSetMetaData
  • GetObjectHistoryCommits
  • Diff

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildURLParams added in v0.0.4

func BuildURLParams(userURL string, params url.Values) (string, error)

BuildURLParams handle URL params

Types

type Branch

type Branch struct {
	Id       string `json:"id"`
	CommitId string `json:"commit_id"`
}

type Branches

type Branches struct {
	Pagination struct {
		HasMore    bool   `json:"has_more"`
		NextOffset string `json:"next_offset"`
		Results    int    `json:"results"`
		MaxPerPage int    `json:"max_per_page"`
	} `json:"pagination"`
	Results []struct {
		Id       string `json:"id"`
		CommitId string `json:"commit_id"`
	} `json:"results"`
}

type CommitHistory added in v0.0.2

type CommitHistory struct {
	Pagination struct {
		HasMore    bool   `json:"has_more"`
		NextOffset string `json:"next_offset"`
		Results    int    `json:"results"`
		MaxPerPage int    `json:"max_per_page"`
	} `json:"pagination"`
	Results []struct {
		Id           string            `json:"id"`
		Parents      []string          `json:"parents"`
		Committer    string            `json:"committer"`
		Message      string            `json:"message"`
		CreationDate int               `json:"creation_date"`
		MetaRangeId  string            `json:"meta_range_id"`
		Metadata     map[string]string `json:"metadata"`
	} `json:"results"`
}

type CommitMessage

type CommitMessage struct {
	Message  string            `json:"message"`
	Metadata map[string]string `json:"metadata"`
}

type CommitResp

type CommitResp struct {
	Id           string            `json:"id"`
	Parents      []string          `json:"parents"`
	Committer    string            `json:"committer"`
	Message      string            `json:"message"`
	CreationDate int               `json:"creation_date"`
	MetaRangeId  string            `json:"meta_range_id"`
	Metadata     map[string]string `json:"metadata"`
}

type CreateRepositoriesResponse

type CreateRepositoriesResponse struct {
	Id               string `json:"id"`
	CreationDate     int    `json:"creation_date"`
	DefaultBranch    string `json:"default_branch"`
	StorageNamespace string `json:"storage_namespace"`
}

type DiffResp added in v0.0.2

type DiffResp struct {
	Pagination struct {
		HasMore    bool   `json:"has_more"`
		NextOffset string `json:"next_offset"`
		Results    int    `json:"results"`
		MaxPerPage int    `json:"max_per_page"`
	} `json:"pagination"`
	Results []struct {
		Type      string `json:"type"`
		Path      string `json:"path"`
		PathType  string `json:"path_type"`
		SizeBytes int    `json:"size_bytes"`
	} `json:"results"`
}

type GetRepositoriesResponse

type GetRepositoriesResponse struct {
	Id               string `json:"id"`
	CreationDate     int    `json:"creation_date"`
	DefaultBranch    string `json:"default_branch"`
	StorageNamespace string `json:"storage_namespace"`
}

type LakeFsSdk

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

func New

func New(addr string, accessKeyID string, secretAccessKey string, timeout time.Duration) (*LakeFsSdk, error)

New 初始化 LakeFsSdk

func (*LakeFsSdk) Branches

func (l *LakeFsSdk) Branches(repository string) (*Branches, error)

Branches 列出所有分支

func (*LakeFsSdk) CreateBranch

func (l *LakeFsSdk) CreateBranch(repository string, branchName string, branchSource string) error

CreateBranch 创建分支

func (*LakeFsSdk) CreateCommit

func (l *LakeFsSdk) CreateCommit(repository string, branchName string, message CommitMessage) (*CommitResp, error)

CreateCommit 创建 commit

func (*LakeFsSdk) CreateRepositories

func (l *LakeFsSdk) CreateRepositories(name, storageNamespace, defaultBranch string) (*CreateRepositoriesResponse, error)

CreateRepositories 创建存储库

func (*LakeFsSdk) DeleteBranch

func (l *LakeFsSdk) DeleteBranch(repository string, branchName string) error

DeleteBranch 删除分支

func (*LakeFsSdk) DeleteObject

func (l *LakeFsSdk) DeleteObject(repository string, branches string, path string) error

DeleteObject DeleteObject, (ref: branch or commit id)

func (*LakeFsSdk) DeleteRepositories

func (l *LakeFsSdk) DeleteRepositories(repository string) error

DeleteRepositories Delete 存储库 Repositories

func (*LakeFsSdk) Diff added in v0.0.2

func (l *LakeFsSdk) Diff(repository string, refs string, rightRef string) (*DiffResp, error)

Diff Diff

func (*LakeFsSdk) GetBranch

func (l *LakeFsSdk) GetBranch(repository string, branchName string) (*Branch, error)

GetBranch 获取分支

func (*LakeFsSdk) GetCommits

func (l *LakeFsSdk) GetCommits(repository string, commitID string) (*CommitResp, error)

GetCommits 获取commits

func (*LakeFsSdk) GetObject

func (l *LakeFsSdk) GetObject(repository string, ref string, path string) ([]byte, error)

GetObject GetObject

func (*LakeFsSdk) GetObjectAndMetadata added in v0.0.5

func (l *LakeFsSdk) GetObjectAndMetadata(repository string, ref string, path string) (body []byte, metadata *Metadata, err error)

GetObjectAndMetadata GetObjectAndMetadata

func (*LakeFsSdk) GetObjectHistoryCommits added in v0.0.2

func (l *LakeFsSdk) GetObjectHistoryCommits(repository string, ref string, path string) (*CommitHistory, error)

GetObjectHistoryCommits 获取文件袋commit历史

func (*LakeFsSdk) GetRepositories

func (l *LakeFsSdk) GetRepositories(repository string) (*GetRepositoriesResponse, error)

GetRepositories 获取 存储库 Repositories

func (*LakeFsSdk) ListObject

func (l *LakeFsSdk) ListObject(repository string, ref string, after string, amount int) (*ListObjects, error)

ListObject 获取对象列表, (ref: branch or commit id)

func (*LakeFsSdk) ListObjectPrefix added in v0.0.7

func (l *LakeFsSdk) ListObjectPrefix(repository string, ref string, prefix string, after string, amount int) (*ListObjects, error)

ListObjectPrefix 获取对象列表, (ref: branch or commit id)

func (*LakeFsSdk) ObjectMetaData

func (l *LakeFsSdk) ObjectMetaData(repository string, ref string, path string) (*Metadata, error)

ObjectMetaData ObjectMetaData, (ref: branch or commit id)

func (*LakeFsSdk) PutObject

func (l *LakeFsSdk) PutObject(repository string, branches string, path string, metadata SetMetadata) (*Metadata, error)

PutObject PutObject

func (*LakeFsSdk) Repositories

func (l *LakeFsSdk) Repositories() (*Repositories, error)

Repositories 获取 所有存储库

func (*LakeFsSdk) UnderlyingProperties

func (l *LakeFsSdk) UnderlyingProperties(repository string, ref string, path string) (*UnderlyingProperties, error)

UnderlyingProperties UnderlyingProperties, (ref: branch or commit id)

func (*LakeFsSdk) UploadObject

func (l *LakeFsSdk) UploadObject(repository string, branches string, path string, data []byte) (*Object, error)

UploadObject UploadObject

func (*LakeFsSdk) UploadObjectAndSetMetaData added in v0.0.2

func (l *LakeFsSdk) UploadObjectAndSetMetaData(repository string, branches string, path string, data []byte, metadata map[string]string) error

UploadObjectAndSetMetaData UploadObjectAndSetMetaData

type ListObjects

type ListObjects struct {
	Pagination struct {
		HasMore    bool   `json:"has_more"`
		NextOffset string `json:"next_offset"`
		Results    int    `json:"results"`
		MaxPerPage int    `json:"max_per_page"`
	} `json:"pagination"`
	Results []Object `json:"results"`
}

type Metadata

type Metadata struct {
	Path            string            `json:"path"`
	PathType        string            `json:"path_type"`
	PhysicalAddress string            `json:"physical_address"`
	Checksum        string            `json:"checksum"`
	SizeBytes       int               `json:"size_bytes"`
	Mtime           int               `json:"mtime"`
	Metadata        map[string]string `json:"metadata"`
	ContentType     string            `json:"content_type"`
}

type Object

type Object struct {
	Path            string            `json:"path"`
	PathType        string            `json:"path_type"`
	PhysicalAddress string            `json:"physical_address"`
	Checksum        string            `json:"checksum"`
	SizeBytes       int               `json:"size_bytes"`
	Mtime           int               `json:"mtime"`
	Metadata        map[string]string `json:"metadata"`
	ContentType     string            `json:"content_type"`
}

type Repositories

type Repositories struct {
	Pagination struct {
		HasMore    bool   `json:"has_more"`
		NextOffset string `json:"next_offset"`
		Results    int    `json:"results"`
		MaxPerPage int    `json:"max_per_page"`
	} `json:"pagination"`
	Results []struct {
		Id               string `json:"id"`
		CreationDate     int    `json:"creation_date"`
		DefaultBranch    string `json:"default_branch"`
		StorageNamespace string `json:"storage_namespace"`
	} `json:"results"`
}

type SetMetadata

type SetMetadata struct {
	PhysicalAddress string            `json:"physical_address"`
	Checksum        string            `json:"checksum"`
	SizeBytes       int               `json:"size_bytes"`
	Mtime           int               `json:"mtime"`
	Metadata        map[string]string `json:"metadata"`
	ContentType     string            `json:"content_type"`
}

type UnderlyingProperties

type UnderlyingProperties struct {
	StorageClass string `json:"storage_class"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL