Method | Description | |
---|---|---|
ChangeLayerAsync ( IFdbTransaction trans, Slice newLayer ) : Task |
Change the layer id of this directory
|
|
CheckLayer ( Slice layer ) : void |
Ensure that this directory was registered with the correct layer id
|
|
CreateAsync ( IFdbTransaction trans, IEnumerable |
Creates a subdirectory with the given path (creating intermediate subdirectories if necessary). An exception is thrown if the given subdirectory already exists.
|
|
CreateOrOpenAsync ( IFdbTransaction trans, IEnumerable |
Opens a subdirectory with the given path. If the subdirectory does not exist, it is created (creating intermediate subdirectories if necessary).
|
|
DumpKey ( Slice key ) : string | ||
ExistsAsync ( IFdbReadOnlyTransaction trans ) : Task |
Checks if this directory exists
|
|
ExistsAsync ( IFdbReadOnlyTransaction trans, IEnumerable |
Checks if a sub-directory exists
|
|
ListAsync ( IFdbReadOnlyTransaction trans ) : Task
|
Returns the list of all the subdirectories of the current directory.
|
|
ListAsync ( IFdbReadOnlyTransaction trans, IEnumerable
|
Returns the list of all the subdirectories of a sub-directory.
|
|
MoveToAsync ( IFdbTransaction trans, IEnumerable |
Moves the current directory to newAbsolutePath. There is no effect on the physical prefix of the given directory, or on clients that already have the directory open. An error is raised if a directory already exists at `new_path`, or if the new path points to a child of the current directory.
|
|
OpenAsync ( IFdbReadOnlyTransaction trans, IEnumerable |
Opens a subdirectory with the given path. An exception is thrown if the subdirectory does not exist, or if a layer is specified and a different layer was specified when the subdirectory was created.
|
|
RegisterAsync ( IFdbTransaction trans, IEnumerable |
Registers an existing prefix as a directory with the given path (creating parent directories if necessary). This method is only indented for advanced use cases.
|
|
RemoveAsync ( IFdbTransaction trans ) : System.Threading.Tasks.Task |
Removes the directory, its contents, and all subdirectories. Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
|
|
RemoveAsync ( IFdbTransaction trans, IEnumerable |
Removes a sub-directory, its contents, and all subdirectories. Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
|
|
ToString ( ) : string |
Returns a user-friendly description of this directory
|
|
TryCreateAsync ( IFdbTransaction trans, IEnumerable |
Creates a subdirectory with the given path (creating intermediate subdirectories if necessary). An exception is thrown if the given subdirectory already exists.
|
|
TryListAsync ( IFdbReadOnlyTransaction trans ) : Task
|
Returns the list of all the subdirectories of a sub-directory, it it exists.
|
|
TryListAsync ( IFdbReadOnlyTransaction trans, IEnumerable
|
Returns the list of all the subdirectories of the current directory, it it exists.
|
|
TryMoveToAsync ( IFdbTransaction trans, IEnumerable |
Attempts to move the current directory to newPath. There is no effect on the physical prefix of the given directory, or on clients that already have the directory open.
|
|
TryOpenAsync ( IFdbReadOnlyTransaction trans, IEnumerable |
Opens a subdirectory with the given path. An exception is thrown if the subdirectory if a layer is specified and a different layer was specified when the subdirectory was created.
|
|
TryRemoveAsync ( IFdbTransaction trans ) : Task |
Attempts to remove the directory, its contents, and all subdirectories. Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
|
|
TryRemoveAsync ( IFdbTransaction trans, IEnumerable |
Attempts to remove a sub-directory, its contents, and all subdirectories. Warning: Clients that have already opened the directory might still insert data into its contents after it is removed.
|
Method | Description | |
---|---|---|
GetLayerForPath ( IFdbTuple relativeLocation ) : |
Return the DirectoryLayer instance that should be called for the given path
|
|
ToRelativePath ( IEnumerable |
Convert a path relative to this directory, into a path relative to the root of the current partition
|
|
ToRelativePath ( IFdbTuple location ) : IFdbTuple |
Convert a path relative to this directory, into a path relative to the root of the current partition
|
Method | Description | |
---|---|---|
FdbDirectorySubspace ( IFdbTuple location, IFdbTuple relativeLocation, Slice prefix, |
||
IFdbDirectory ( IFdbTransaction trans, IEnumerable |
Moves the specified subdirectory to newPath. There is no effect on the physical prefix of the given directory, or on clients that already have the directory open. An error is raised if a directory already exists at `new_path`.
|
public ChangeLayerAsync ( IFdbTransaction trans, Slice newLayer ) : Task |
||
trans | IFdbTransaction | Transaction to use for the operation |
newLayer | Slice | New layer id of this directory |
return | Task |
public CheckLayer ( Slice layer ) : void | ||
layer | Slice | Expected layer id (if not empty) |
return | void |
public CreateAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
path | IEnumerable |
Relative path of the subdirectory to create |
layer | Slice | If |
return | Task |
public CreateOrOpenAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
path | IEnumerable |
Relative path of the subdirectory to create or open |
layer | Slice | If |
return | Task |
public ExistsAsync ( IFdbReadOnlyTransaction trans ) : Task |
||
trans | IFdbReadOnlyTransaction | |
return | Task |
public ExistsAsync ( IFdbReadOnlyTransaction trans, IEnumerable |
||
trans | IFdbReadOnlyTransaction | |
path | IEnumerable |
|
return | Task |
protected GetLayerForPath ( IFdbTuple relativeLocation ) : |
||
relativeLocation | IFdbTuple | Location relative to this directory subspace |
return |
public ListAsync ( IFdbReadOnlyTransaction trans ) : Task
|
||
trans | IFdbReadOnlyTransaction | |
return | Task
|
public ListAsync ( IFdbReadOnlyTransaction trans, IEnumerable
|
||
trans | IFdbReadOnlyTransaction | |
path | IEnumerable |
|
return | Task
|
public MoveToAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
newAbsolutePath | IEnumerable |
Full path (from the root) where this directory will be moved |
return | Task |
public OpenAsync ( IFdbReadOnlyTransaction trans, IEnumerable |
||
trans | IFdbReadOnlyTransaction | Transaction to use for the operation |
path | IEnumerable |
Relative path of the subdirectory to open |
layer | Slice | If specified, the opened directory must have the same layer id. |
return | Task |
public RegisterAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
path | IEnumerable |
Path of the directory to create |
layer | Slice | If |
prefix | Slice | The directory will be created with the given physical prefix; otherwise a prefix is allocated automatically. |
return | Task |
public RemoveAsync ( IFdbTransaction trans ) : System.Threading.Tasks.Task | ||
trans | IFdbTransaction | Transaction to use for the operation |
return | System.Threading.Tasks.Task |
public RemoveAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
path | IEnumerable |
Path of the sub-directory to remove (relative to this directory) |
return | System.Threading.Tasks.Task |
protected ToRelativePath ( IEnumerable |
||
path | IEnumerable |
Path relative from this directory |
return | IFdbTuple |
protected ToRelativePath ( IFdbTuple location ) : IFdbTuple | ||
location | IFdbTuple | Path relative from this directory |
return | IFdbTuple |
public TryCreateAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
path | IEnumerable |
Relative path of the subdirectory to create |
layer | Slice | If |
return | Task |
public TryListAsync ( IFdbReadOnlyTransaction trans ) : Task
|
||
trans | IFdbReadOnlyTransaction | |
return | Task
|
public TryListAsync ( IFdbReadOnlyTransaction trans, IEnumerable
|
||
trans | IFdbReadOnlyTransaction | |
path | IEnumerable |
|
return | Task
|
public TryMoveToAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
newPath | IEnumerable |
Full path (from the root) where this directory will be moved |
return | Task |
public TryOpenAsync ( IFdbReadOnlyTransaction trans, IEnumerable |
||
trans | IFdbReadOnlyTransaction | Transaction to use for the operation |
path | IEnumerable |
Relative path of the subdirectory to open |
layer | Slice | If specified, the opened directory must have the same layer id. |
return | Task |
public TryRemoveAsync ( IFdbTransaction trans ) : Task |
||
trans | IFdbTransaction | Transaction to use for the operation |
return | Task |
public TryRemoveAsync ( IFdbTransaction trans, IEnumerable |
||
trans | IFdbTransaction | Transaction to use for the operation |
path | IEnumerable |
Path of the sub-directory to remove (relative to this directory) |
return | Task |