Documentation
¶
Overview ¶
Package index provides ready-to-use tables and DAOs for storing hierarchical data using the nested sets pattern
Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
This file is part of Pydio Cells. *
Pydio Cells is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. *
Pydio Cells is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details. *
You should have received a copy of the GNU Affero General Public License
along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>. *
The latest code can be found at <https://pydio.com>.
Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
This file is part of Pydio Cells. *
Pydio Cells is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. *
Pydio Cells is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details. *
You should have received a copy of the GNU Affero General Public License
along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>. *
The latest code can be found at <https://pydio.com>.
Copyright (c) 2018. Abstrium SAS <team (at) pydio.com>
This file is part of Pydio Cells. *
Pydio Cells is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. *
Pydio Cells is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details. *
You should have received a copy of the GNU Affero General Public License
along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>. *
The latest code can be found at <https://pydio.com>.
Index ¶
- func NewDAO(o dao.DAO, rootNodeId string) dao.DAO
- func NewNode(treeNode *tree.Node, path mtree.MPath, filenames []string) *mtree.TreeNode
- func RegisterIndexLen(len int)
- type BatchSend
- type CacheDAO
- type DAO
- type DAOWrapper
- type FolderSizeCacheSQL
- func (dao *FolderSizeCacheSQL) AddNode(node *mtree.TreeNode) error
- func (dao *FolderSizeCacheSQL) DelNode(node *mtree.TreeNode) error
- func (dao *FolderSizeCacheSQL) GetNode(path mtree.MPath) (*mtree.TreeNode, error)
- func (dao *FolderSizeCacheSQL) GetNodeByUUID(uuid string) (*mtree.TreeNode, error)
- func (dao *FolderSizeCacheSQL) GetNodeChildren(path mtree.MPath) chan interface{}
- func (dao *FolderSizeCacheSQL) GetNodeTree(path mtree.MPath) chan interface{}
- func (dao *FolderSizeCacheSQL) GetSQLDAO() sql.DAO
- func (dao *FolderSizeCacheSQL) MoveNodeTree(nodeFrom *mtree.TreeNode, nodeTo *mtree.TreeNode) error
- func (dao *FolderSizeCacheSQL) Path(strpath string, create bool, reqNode ...*tree.Node) (mtree.MPath, []*mtree.TreeNode, error)
- func (dao *FolderSizeCacheSQL) SetNode(node *mtree.TreeNode) error
- type HiddenFileDuplicateRemoverSQL
- type IndexSQL
- func (dao *IndexSQL) AddNode(node *mtree.TreeNode) error
- func (dao *IndexSQL) AddNodeStream(max int) (chan *mtree.TreeNode, chan error)
- func (dao *IndexSQL) CleanResourcesOnDeletion() (error, string)
- func (dao *IndexSQL) DelNode(node *mtree.TreeNode) error
- func (dao *IndexSQL) FixLostAndFound(lost LostAndFound) error
- func (dao *IndexSQL) FixRandHash2(excludes ...LostAndFound) (int64, error)
- func (dao *IndexSQL) Flush(final bool) error
- func (dao *IndexSQL) GetNode(path mtree.MPath) (*mtree.TreeNode, error)
- func (dao *IndexSQL) GetNodeByUUID(uuid string) (*mtree.TreeNode, error)
- func (dao *IndexSQL) GetNodeChild(reqPath mtree.MPath, reqName string) (*mtree.TreeNode, error)
- func (dao *IndexSQL) GetNodeChildren(path mtree.MPath) chan interface{}
- func (dao *IndexSQL) GetNodeChildrenCounts(path mtree.MPath) (int, int)
- func (dao *IndexSQL) GetNodeFirstAvailableChildIndex(reqPath mtree.MPath) (available uint64, e error)
- func (dao *IndexSQL) GetNodeLastChild(reqPath mtree.MPath) (*mtree.TreeNode, error)
- func (dao *IndexSQL) GetNodeTree(path mtree.MPath) chan interface{}
- func (dao *IndexSQL) GetNodes(mpathes ...mtree.MPath) chan *mtree.TreeNode
- func (dao *IndexSQL) GetSQLDAO() sql.DAO
- func (dao *IndexSQL) Init(options configx.Values) error
- func (dao *IndexSQL) LostAndFounds() (output []LostAndFound, err error)
- func (dao *IndexSQL) MoveNodeTree(nodeFrom *mtree.TreeNode, nodeTo *mtree.TreeNode) error
- func (dao *IndexSQL) Path(strpath string, create bool, reqNode ...*tree.Node) (mtree.MPath, []*mtree.TreeNode, error)
- func (dao *IndexSQL) ResyncDirtyEtags(rootNode *mtree.TreeNode) error
- func (dao *IndexSQL) SetNode(node *mtree.TreeNode) error
- func (dao *IndexSQL) SetNodeMeta(node *mtree.TreeNode) error
- func (dao *IndexSQL) SetNodes(etag string, deltaSize int64) sql.BatchSender
- type LostAndFound
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterIndexLen ¶
func RegisterIndexLen(len int)
Types ¶
type BatchSend ¶
type BatchSend struct {
// contains filtered or unexported fields
}
BatchSend sql structure
type DAO ¶
type DAO interface { Path(strpath string, create bool, reqNode ...*tree.Node) (mtree.MPath, []*mtree.TreeNode, error) // Add a node in the tree AddNode(*mtree.TreeNode) error // SetNode updates a node, including its tree position SetNode(*mtree.TreeNode) error // Update a node metadata, without touching its tree position SetNodeMeta(*mtree.TreeNode) error // Remove a node from the tree DelNode(*mtree.TreeNode) error // Simple Add / Set / Delete AddNodeStream(int) (chan *mtree.TreeNode, chan error) Flush(bool) error // Batch Add / Set / Delete GetNodes(...mtree.MPath) chan *mtree.TreeNode SetNodes(string, int64) sql.BatchSender // Getters GetNode(mtree.MPath) (*mtree.TreeNode, error) GetNodeByUUID(string) (*mtree.TreeNode, error) GetNodeChildren(mtree.MPath) chan interface{} GetNodeTree(mtree.MPath) chan interface{} GetNodeChild(mtree.MPath, string) (*mtree.TreeNode, error) GetNodeLastChild(mtree.MPath) (*mtree.TreeNode, error) GetNodeFirstAvailableChildIndex(mtree.MPath) (uint64, error) GetNodeChildrenCounts(mtree.MPath) (int, int) MoveNodeTree(nodeFrom *mtree.TreeNode, nodeTo *mtree.TreeNode) error CleanResourcesOnDeletion() (error, string) LostAndFounds() ([]LostAndFound, error) FixLostAndFound(lost LostAndFound) error FixRandHash2(excludes ...LostAndFound) (int64, error) GetSQLDAO() sql.DAO }
DAO interface
func GetDAOCache ¶
GetDAOCache returns the cache based on the session name
func NewDAOCache ¶
NewDAOCache wraps a cache around the dao
func NewFolderSizeCacheDAO ¶
NewFolderSizeCacheDAO provides a middleware implementation of the index sql dao that removes duplicate entries of the .pydio file that have the same etag at the same level
func NewHiddenFileDuplicateRemoverDAO ¶
NewHiddenFileDuplicateRemoverDAO provides a middleware implementation of the index sql dao that removes duplicate entries of the .pydio file that have the same etag at the same level
type DAOWrapper ¶
type FolderSizeCacheSQL ¶
type FolderSizeCacheSQL struct {
DAO
}
FolderSizeCacheSQL implementation
func (*FolderSizeCacheSQL) AddNode ¶
func (dao *FolderSizeCacheSQL) AddNode(node *mtree.TreeNode) error
Add a node in the tree
func (*FolderSizeCacheSQL) DelNode ¶
func (dao *FolderSizeCacheSQL) DelNode(node *mtree.TreeNode) error
Remove a node from the tree
func (*FolderSizeCacheSQL) GetNodeByUUID ¶
func (dao *FolderSizeCacheSQL) GetNodeByUUID(uuid string) (*mtree.TreeNode, error)
GetNodeByUUID returns the node stored with the unique uuid
func (*FolderSizeCacheSQL) GetNodeChildren ¶
func (dao *FolderSizeCacheSQL) GetNodeChildren(path mtree.MPath) chan interface{}
GetNodeChildren List
func (*FolderSizeCacheSQL) GetNodeTree ¶
func (dao *FolderSizeCacheSQL) GetNodeTree(path mtree.MPath) chan interface{}
GetNodeTree List from the path
func (*FolderSizeCacheSQL) GetSQLDAO ¶
func (dao *FolderSizeCacheSQL) GetSQLDAO() sql.DAO
func (*FolderSizeCacheSQL) MoveNodeTree ¶
MoveNodeTree move all the nodes belonging to a tree by calculating the new mpathes
type HiddenFileDuplicateRemoverSQL ¶
type HiddenFileDuplicateRemoverSQL struct {
DAO
}
HiddenFileDuplicateRemoverSQL implementation
func (*HiddenFileDuplicateRemoverSQL) Flush ¶
func (dao *HiddenFileDuplicateRemoverSQL) Flush(final bool) error
Flush the database after big updates
func (*HiddenFileDuplicateRemoverSQL) GetSQLDAO ¶
func (dao *HiddenFileDuplicateRemoverSQL) GetSQLDAO() sql.DAO
type IndexSQL ¶
IndexSQL implementation
func (*IndexSQL) AddNodeStream ¶
AddNodeStream creates a channel to write to the SQL database
func (*IndexSQL) CleanResourcesOnDeletion ¶
CleanResourcesOnDeletion revert the creation of the table for a datasource
func (*IndexSQL) FixLostAndFound ¶
func (dao *IndexSQL) FixLostAndFound(lost LostAndFound) error
FixLostAndFound receives LostAndFound that are ready for deletion
func (*IndexSQL) FixRandHash2 ¶
func (dao *IndexSQL) FixRandHash2(excludes ...LostAndFound) (int64, error)
FixRandHash2 looks up for hash2 in the form 'random-%' and recompute them as proper has of parents + name
func (*IndexSQL) GetNodeByUUID ¶
GetNodeByUUID returns the node stored with the unique uuid
func (*IndexSQL) GetNodeChild ¶
GetNodeChild from node path whose name matches
func (*IndexSQL) GetNodeChildren ¶
GetNodeChildren List
func (*IndexSQL) GetNodeChildrenCounts ¶ added in v1.5.0
GetNodeChildrenCounts List
func (*IndexSQL) GetNodeFirstAvailableChildIndex ¶
func (dao *IndexSQL) GetNodeFirstAvailableChildIndex(reqPath mtree.MPath) (available uint64, e error)
GetNodeFirstAvailableChildIndex from path
func (*IndexSQL) GetNodeLastChild ¶
GetNodeLastChild from path
func (*IndexSQL) GetNodeTree ¶
GetNodeTree List from the path
func (*IndexSQL) LostAndFounds ¶
func (dao *IndexSQL) LostAndFounds() (output []LostAndFound, err error)
func (*IndexSQL) MoveNodeTree ¶
MoveNodeTree move all the nodes belonging to a tree by calculating the new mpathes
func (*IndexSQL) ResyncDirtyEtags ¶
ResyncDirtyEtags ensures that etags are rightly calculated
func (*IndexSQL) SetNodeMeta ¶ added in v1.6.2
SetNode in replacement of previous node