|
abstract void | closeReader (long readerID) throws UdfException, DestroyInvocation |
|
abstract void | closeWriter (long writerID) throws UdfException, DestroyInvocation |
|
abstract int | deleteIt (String fileName, boolean isRecursively) throws UdfException, DestroyInvocation |
|
abstract void | finalize () |
|
abstract boolean | initDFSFile (DFSFile file) throws UdfException, DestroyInvocation |
|
abstract List< DFSFile > | listFiles (String fileName) throws UdfException, DestroyInvocation |
|
abstract long | openForRead (String fileName, DFSFile.DFSRootParentType parentType, String parentName) throws UdfException, DestroyInvocation |
|
abstract long | openForWrite (String fileName, DFSFile.DFSScope dfsScope, DFSFile.DFSDistribution dfsDistrib) throws UdfException, DestroyInvocation |
|
abstract int | read (long readerID, ByteBuffer buffer, int size) throws UdfException, DestroyInvocation |
|
abstract long | seek (long readerID, long offset, int origin) throws UdfException, DestroyInvocation |
|
abstract int | write (long writerID, ByteBuffer buffer) throws UdfException, DestroyInvocation |
|
File Manager is a session level co-ordinator, which will be used by DFSFile, DFSFileReader and DFSFileWriter to interact with Catalog and Storage system of Vertica.
Closes the file opened for reading, identified by 'readerID'
- Parameters
-
readerID | id of the reader to close |
- Exceptions
-
Closes the file opened for writing, identified by 'writerID'
- Parameters
-
writerID | id of the writer to close |
- Exceptions
-
Deletes a DFSFile, identified by full path 'fileName'.
- Parameters
-
fileName | the file or directory to delete |
isRecursively | whether to delete recursively |
- Returns
- 0 if successful, throw exceptions if there are errors
- Exceptions
-
abstract void com.vertica.sdk.FileManager.finalize |
( |
| ) |
|
|
pure virtual |
Finalizes a plan/query/statement. Should only invoke on the initiator node of a query. Complete file replication and commit metadata into the catalog. returns nothing, throws exceptions if there are errors.
Initialize a DFSFile upon constructing.
- Parameters
-
file | the DFS file to initialize |
- Returns
- true if file exists in the DFS, false otherwise
- Exceptions
-
Lists file under the path specified by 'fileName'
- Parameters
-
fileName | name of file/directory to list |
- Returns
- a list of DFSFile found under the path.
- Exceptions
-
abstract long com.vertica.sdk.FileManager.openForRead |
( |
String |
fileName, |
|
|
DFSFile.DFSRootParentType |
parentType, |
|
|
String |
parentName |
|
) |
| throws UdfException, DestroyInvocation |
|
pure virtual |
Opens a file for reading
- Parameters
-
fileName | the filename |
parentType | type of the parent |
parentName | name of the parent |
- Returns
- A unique identifier for the file opened. Return value is less than 0 if there are errors
- Exceptions
-
abstract long com.vertica.sdk.FileManager.openForWrite |
( |
String |
fileName, |
|
|
DFSFile.DFSScope |
dfsScope, |
|
|
DFSFile.DFSDistribution |
dfsDistrib |
|
) |
| throws UdfException, DestroyInvocation |
|
pure virtual |
Opens a file for writing
- Parameters
-
fileName | name of file |
dfsScope | scope |
dfsDistrib | distribution |
- Returns
- A unique identifier for the file opened. Return value is less tan 0 if there are errors
- Exceptions
-
Reads 'size' of bytes into buffer from the file identified by 'readerID'.
- Parameters
-
readerID | id of the file reader |
buffer | ByteBuffer to read into |
size | number of bytes to read |
- Returns
- number of bytes actually read, 0 if no bytes were read, indicates the EOF.
- Exceptions
-
Reposition the read file offset
- Parameters
-
readerID | id of the file reader |
offset | offset to seek to |
origin | origin from which to seek |
- Returns
- the new file offset.
- Exceptions
-
Writes bytes into the file identified by 'writerID' from the buffer.
Bytes are retrieved from buffer starting from the current position till it's limit. Current position will be advanced depending on how many bytes are written.
- Parameters
-
writerID | id of the writer |
buffer | ByteBuffer from which to write |
- Returns
- number of bytes actually written, less than 0 if there are any errors.
- Exceptions
-