Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

add(E) - Method in class net.snowflake.ingest.utils.RingBuffer
add - appends an element to the end of this queue

B

BackOffException - Exception in net.snowflake.ingest.utils
BackOffException - Exception thrown when we have to back off
BackOffException() - Constructor for exception net.snowflake.ingest.utils.BackOffException
 
BackOffException(String) - Constructor for exception net.snowflake.ingest.utils.BackOffException
 
BackOffException(String, Throwable) - Constructor for exception net.snowflake.ingest.utils.BackOffException
 
BackOffException(Throwable) - Constructor for exception net.snowflake.ingest.utils.BackOffException
 
build() - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
build - returns a new instance of SimpleIngestManager using the information set in this builder object
Builder() - Constructor for class net.snowflake.ingest.SimpleIngestManager.Builder
 

C

clear() - Method in class net.snowflake.ingest.utils.RingBuffer
clear - effectively empties the array by resetting all of our pointers and clearing our buffer
contains(Object) - Method in class net.snowflake.ingest.utils.RingBuffer
contains - checks whether or not an object is in this queue
createTempCsv(String, String, int) - Static method in class net.snowflake.ingest.example.IngestExampleHelper
 
Cryptor - Class in net.snowflake.ingest.utils
 
Cryptor() - Constructor for class net.snowflake.ingest.utils.Cryptor
 

D

doQuery(Connection, String) - Static method in class net.snowflake.ingest.example.IngestExampleHelper
Try to execute a SQL query and throw if it fails

E

element() - Method in class net.snowflake.ingest.utils.RingBuffer
element Returns the element current under the read pointer Does NOT update the read position

F

FileEntry() - Constructor for class net.snowflake.ingest.connection.HistoryResponse.FileEntry
 
files - Variable in class net.snowflake.ingest.connection.HistoryRangeResponse
the list of file status objects
files - Variable in class net.snowflake.ingest.connection.HistoryResponse
the list of file status objects
findByStatusId(int) - Static method in enum net.snowflake.ingest.connection.IngestStatus
Search file Status given its id

G

generateHistoryRangeRequest(UUID, String, String, String) - Method in class net.snowflake.ingest.connection.RequestBuilder
generateHistoryRangeRequest - given a requestId and a pipe, get history for all ingests between time ranges start-end
generateHistoryRequest(UUID, String, Integer, String) - Method in class net.snowflake.ingest.connection.RequestBuilder
generateHistoryRequest - given a requestId and a pipe, make a history request
generateInsertRequest(UUID, String, List<StagedFileWrapper>) - Method in class net.snowflake.ingest.connection.RequestBuilder
generateInsertRequest - given a table, stage and list of files, make a request for the insert endpoint
generateKeyPair() - Static method in class net.snowflake.ingest.example.IngestExampleHelper
Generates an RSA keypair for use in this test
getAccount() - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
getAccount - returns the name of the account this builder will inject into the IngestManager
getAccount() - Method in class net.snowflake.ingest.SimpleIngestManager
getAccount - Gives back the name of the account that this IngestManager is targeting
getCapacity() - Method in class net.snowflake.ingest.utils.RingBuffer
getCapacity - gives back the capacity of this buffer
getConnection(String, String, String, String, int) - Static method in class net.snowflake.ingest.example.IngestExampleHelper
 
getEndTimeExclusive() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
endTimeExclusive (timestamp in ISO-8601 format) provided in the request.
getErrorLimit() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of errors allowed in the file before it is considered failed (based on ON_ERROR copy option).
getErrorsSeen() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of errors seen in the file
getFileSize() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
The size of the file as measured by the service
getFirstError() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Error message for the first error encountered in this file.
getFirstErrorCharacterPos() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Character position of the first error.
getFirstErrorColumnName() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Column name where the first error occurred.
getFirstErrorLineNum() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Line number of the first error.
getHistory(UUID, Integer, String) - Method in class net.snowflake.ingest.SimpleIngestManager
Pings the service to see the current ingest history for this table
getHistory(UUID) - Method in class net.snowflake.ingest.SimpleIngestManager
Pings the service to see the current ingest history for this table
getHistoryRange(UUID, String, String) - Method in class net.snowflake.ingest.SimpleIngestManager
Pings the service to see the current ingest history for this table
getHttpClient() - Static method in class net.snowflake.ingest.utils.HttpUtil
 
getId() - Method in enum net.snowflake.ingest.connection.IngestStatus
id of the IngestStatus object
getKeypair() - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
getKeyPair - returns the key-pair we're using for authentication
getLastInsertTime() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
getLastInsertTime - converts the ISO formatted lastInsertTime string into a LocalDateTime
getNextBeginMark() - Method in class net.snowflake.ingest.connection.HistoryResponse
beginMark to use on the next request to avoid seeing duplicate records.
getPath() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
The file path relative to the stage location.
getPath() - Method in class net.snowflake.ingest.utils.StagedFileWrapper
getPath - returns the path of this file
getPipe() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
fully qualified pipe name
getPipe() - Method in class net.snowflake.ingest.connection.HistoryResponse
fully qualified pipe name
getPipe() - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
getPipe - get the pipe for the ingest manager this builder will create
getPipe() - Method in class net.snowflake.ingest.SimpleIngestManager
getPipe - gives back the pipe which we are using
getPublicKeyString(KeyPair) - Static method in class net.snowflake.ingest.example.IngestExampleHelper
Generate the public key as a string
getRangeEndTime() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
lastInsertTime (timestamp in ISO-8601 format) of the latest entry in the files included in the response.
getRangeStartTime() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
lastInsertTime (timestamp in ISO-8601 format) of the oldest entry in the files included in the response.
getRequestId() - Method in class net.snowflake.ingest.connection.IngestResponse
 
getRequestUUID() - Method in class net.snowflake.ingest.connection.IngestResponse
getRequestUUID - the requestId as a UUID
getResponseCode() - Method in class net.snowflake.ingest.connection.IngestResponse
 
getRowsInserted() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of rows inserted into the target table from the file.
getRowsParsed() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of rows parsed from the file.
getSize() - Method in class net.snowflake.ingest.utils.StagedFileWrapper
getSize - get the size of this file
getStageLocation() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Either the stage ID (internal stage) or the S3 bucket (external stage) defined in the pipe.
getStartTimeInclusive() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
startTimeInclusive (timestamp in ISO-8601 format) provided in the request.
getStatistics() - Method in class net.snowflake.ingest.connection.HistoryResponse
the statistics reported back by the service
getStatus() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Load status for the file: LOAD_IN_PROGRESS: Part of the file has been loaded into the table, but the load process has not completed yet.
getStatusDesc() - Method in enum net.snowflake.ingest.connection.IngestStatus
description associated to that file Status
getSystemError() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
General error describing why the file was not processed.
getTimeReceived() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
The time at which this file was enqueued by the service ISO 8601 UTC
getUser() - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
getUser - get the user who will be loading using the ingest service
getUser() - Method in class net.snowflake.ingest.SimpleIngestManager
getUser - gives back the user on behalf of which this ingest manager is loading

H

HistoryRangeResponse - Class in net.snowflake.ingest.connection
HistoryRangeResponse - response containing all history for a given pipe within a given date range, received from range history endpoint.
HistoryRangeResponse() - Constructor for class net.snowflake.ingest.connection.HistoryRangeResponse
 
HistoryResponse - Class in net.snowflake.ingest.connection
HistoryResponse - an object containing a response we've received from the history endpoint
HistoryResponse() - Constructor for class net.snowflake.ingest.connection.HistoryResponse
 
HistoryResponse.FileEntry - Class in net.snowflake.ingest.connection
FileEntry - a pojo containing all of the data about a file reported back from the service
HttpUtil - Class in net.snowflake.ingest.utils
Created by hyu on 8/10/17.
HttpUtil() - Constructor for class net.snowflake.ingest.utils.HttpUtil
 

I

IngestExampleHelper - Class in net.snowflake.ingest.example
Helper methods to connect to snowflake jdbc and run queries Created by vganesh on 5/19/17.
IngestExampleHelper() - Constructor for class net.snowflake.ingest.example.IngestExampleHelper
 
ingestFile(StagedFileWrapper, UUID) - Method in class net.snowflake.ingest.SimpleIngestManager
ingestFile - ingest a single file
ingestFiles(List<StagedFileWrapper>, UUID) - Method in class net.snowflake.ingest.SimpleIngestManager
ingestFiles - synchronously sends a request to the ingest service to enqueue these files
IngestResponse - Class in net.snowflake.ingest.connection
IngestResponse - an object which contains a successful response from the service for the insert request
IngestResponse() - Constructor for class net.snowflake.ingest.connection.IngestResponse
 
IngestResponseException - Exception in net.snowflake.ingest.connection
Exception will capture error message when Snowflake encounters an error during ingest or if trying to retrieve history report/ Created by vganesh on 5/20/17.
IngestStatus - Enum in net.snowflake.ingest.connection
Status of ingest of a particular file returned by Snowflake in the FileEntry history response per file Created by vganesh on 5/22/17.
isComplete() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Indicates whether the was file completely processed successfully.
isCompleteResult() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
False if the report is incomplete, i.e.
isCompleteResult() - Method in class net.snowflake.ingest.connection.HistoryResponse
False if an event was missed between the supplied beginMark and the first event in this report history.
isEmpty() - Method in class net.snowflake.ingest.utils.RingBuffer
isEmpty - are there any items we can get from this queue?
iterator() - Method in class net.snowflake.ingest.utils.RingBuffer
iterator - returns an iterator that allows you to view all elements in this queue This iterator does NOT allow for remove()

L

lookupByName(String) - Static method in enum net.snowflake.ingest.connection.IngestStatus
Given an enum name, find associated IngestStatus

M

main(String[]) - Static method in class net.snowflake.ingest.example.SnowflakeIngestBasicExample
 
makeLocalDirectory(String) - Static method in class net.snowflake.ingest.example.IngestExampleHelper
Create directories if they don't exist under directoryPath.
makeSampleFile(String, String) - Static method in class net.snowflake.ingest.example.IngestExampleHelper
Create file under directoryPath with fileName and populate it with test data

N

net.snowflake.ingest - package net.snowflake.ingest
 
net.snowflake.ingest.connection - package net.snowflake.ingest.connection
 
net.snowflake.ingest.example - package net.snowflake.ingest.example
 
net.snowflake.ingest.utils - package net.snowflake.ingest.utils
 

O

offer(E) - Method in class net.snowflake.ingest.utils.RingBuffer
offer - attempts to add an object to the queue, if the queue is at capacity, return false

P

peek() - Method in class net.snowflake.ingest.utils.RingBuffer
peek - Returns the element currently under the read pointer Does NOT update the read position If there is no valid element, return null
poll() - Method in class net.snowflake.ingest.utils.RingBuffer
poll - returns the head of this queue and removes it from the queue.
poolThreadFactory(String, boolean) - Static method in class net.snowflake.ingest.utils.ThreadFactoryUtil
 

R

remove() - Method in class net.snowflake.ingest.utils.RingBuffer
remove - returns the current head of this queue and removes it This *does* update the read position
RequestBuilder - Class in net.snowflake.ingest.connection
This class handles constructing the URIs for our requests as well as putting together the payloads we'll be sending
RequestBuilder(String, String, KeyPair) - Constructor for class net.snowflake.ingest.connection.RequestBuilder
RequestBuilder - general usage constructor
RequestBuilder(String, String, KeyPair, String, String, int) - Constructor for class net.snowflake.ingest.connection.RequestBuilder
RequestBuilder - this constructor is for testing purposes only
RingBuffer<E> - Class in net.snowflake.ingest.utils
 
RingBuffer(int) - Constructor for class net.snowflake.ingest.utils.RingBuffer
Constructs a ring buffer with a specified size

S

ServiceResponseHandler - Class in net.snowflake.ingest.connection
This class handles taking the HttpResponses we've gotten back, and producing an appropriate response object for usage
ServiceResponseHandler() - Constructor for class net.snowflake.ingest.connection.ServiceResponseHandler
 
setAccount(String) - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
setAccount - set the account for the ingest manager and return this builder
setComplete(Boolean) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Indicates whether the was file completely processed successfully.
setCompleteResult(boolean) - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
 
setCompleteResult(Boolean) - Method in class net.snowflake.ingest.connection.HistoryResponse
False if an event was missed between the supplied beginMark and the first event in this report history.
setEndTimeExclusive(String) - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
endTimeExclusive (timestamp in ISO-8601 format) provided in the request.
setErrorLimit(Long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of errors allowed in the file before it is considered failed (based on ON_ERROR copy option).
setErrorsSeen(Long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of errors seen in the file
setFileSize(Long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
The size of the file as measured by the service
setFirstError(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Error message for the first error encountered in this file.
setFirstErrorCharacterPos(Long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Character position of the first error.
setFirstErrorColumnName(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Column name where the first error occurred.
setFirstErrorLineNum(Long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Line number of the first error.
setKeypair(KeyPair) - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
setKeypair - sets the RSA 2048 bit keypair we'll be using for token signing
setLastInsertTime(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Time data from this file was last inserted into the table.
setNextBeginMark(String) - Method in class net.snowflake.ingest.connection.HistoryResponse
beginMark to use on the next request to avoid seeing duplicate records.
setPath(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
The file path relative to the stage location.
setPipe(String) - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
fully qualified pipe name
setPipe(String) - Method in class net.snowflake.ingest.connection.HistoryResponse
fully qualified pipe name
setPipe(String) - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
setTable - sets the pipe which the SimpleIngestManager will be using
setRangeEndTime(String) - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
lastInsertTime (timestamp in ISO-8601 format) of the latest entry in the files included in the response.
setRangeStartTime(String) - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
lastInsertTime (timestamp in ISO-8601 format) of the oldest entry in the files included in the response.
setRowsInserted(Long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of rows inserted into the target table from the file.
setRowsParsed(long) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Number of rows parsed from the file.
setStageLocation(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Either the stage ID (internal stage) or the S3 bucket (external stage) defined in the pipe.
setStartTimeInclusive(String) - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
startTimeInclusive (timestamp in ISO-8601 format) provided in the request.
setStatistics(HistoryResponse.HistoryStats) - Method in class net.snowflake.ingest.connection.HistoryResponse
the statistics reported back by the service
setStatus(IngestStatus) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
Load status for the file: LOAD_IN_PROGRESS: Part of the file has been loaded into the table, but the load process has not completed yet.
setSystemError(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
General error describing why the file was not processed.
setTimeReceived(String) - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
The time at which this file was enqueued by the service ISO 8601 UTC
setUser(String) - Method in class net.snowflake.ingest.SimpleIngestManager.Builder
setUser - sets the user who will be loading with the ingest manager
sha256Hash(byte[], int, int) - Static method in class net.snowflake.ingest.utils.Cryptor
Hashes input bytes using SHA-256.
sha256Hash(byte[]) - Static method in class net.snowflake.ingest.utils.Cryptor
Hashes input bytes using SHA-256.
sha256HashBase64(byte[]) - Static method in class net.snowflake.ingest.utils.Cryptor
Hashes input bytes using SHA-256 and converts hash into a string using Base64 encoding.
SimpleIngestManager - Class in net.snowflake.ingest
This class provides a basic, low-level abstraction over the Snowflake Ingest Service REST api
SimpleIngestManager(String, String, String, KeyPair) - Constructor for class net.snowflake.ingest.SimpleIngestManager
Deprecated.
SimpleIngestManager(String, String, String, PrivateKey) - Constructor for class net.snowflake.ingest.SimpleIngestManager
Constructs a SimpleIngestManager for a given user in a specific account In addition, this also takes takes the target table and source stage Finally, it also requires a valid private key registered with Snowflake DB Note: this method only takes in account parameter and derive the hostname, i.e.
SimpleIngestManager(String, String, String, KeyPair, String, String, int) - Constructor for class net.snowflake.ingest.SimpleIngestManager
Deprecated.
SimpleIngestManager(String, String, String, PrivateKey, String, String, int) - Constructor for class net.snowflake.ingest.SimpleIngestManager
Constructs a SimpleIngestManager for a given user in a specific account In addition, this also takes takes the target table and source stage Finally, it also requires a valid private key registered with Snowflake DB
SimpleIngestManager.Builder - Class in net.snowflake.ingest
This Builder allows someone to configure a SimpleIngestManager prior to instantiating the manager
size() - Method in class net.snowflake.ingest.utils.RingBuffer
size - returns the number of occupied slots in this queue
SnowflakeIngestBasicExample - Class in net.snowflake.ingest.example
This sample demonstrates how to make basic requests to the Snowflake Ingest service for Java.
SnowflakeIngestBasicExample() - Constructor for class net.snowflake.ingest.example.SnowflakeIngestBasicExample
 
StagedFileWrapper - Class in net.snowflake.ingest.utils
RemoteFileWrapper for a file path in the target stage as well as an optional size
StagedFileWrapper(String, Long) - Constructor for class net.snowflake.ingest.utils.StagedFileWrapper
StagedFileWrapper - just wraps the path of a file and its size for serialization
StagedFileWrapper(String) - Constructor for class net.snowflake.ingest.utils.StagedFileWrapper
StagedFileWrapper - just setting the path without a size

T

ThreadFactoryUtil - Class in net.snowflake.ingest.utils
This class provides support functions for writing a thread factory wrapper
ThreadFactoryUtil() - Constructor for class net.snowflake.ingest.utils.ThreadFactoryUtil
 
toArray() - Method in class net.snowflake.ingest.utils.RingBuffer
toArray - builds an array containing all objects in this queue
toString() - Method in class net.snowflake.ingest.connection.HistoryRangeResponse
 
toString() - Method in class net.snowflake.ingest.connection.HistoryResponse.FileEntry
 
toString() - Method in class net.snowflake.ingest.connection.HistoryResponse
 
toString() - Method in class net.snowflake.ingest.connection.IngestResponse
 
toString() - Method in exception net.snowflake.ingest.connection.IngestResponseException
 

U

unmarshallHistoryRangeResponse(HttpResponse) - Static method in class net.snowflake.ingest.connection.ServiceResponseHandler
 
unmarshallHistoryResponse(HttpResponse) - Static method in class net.snowflake.ingest.connection.ServiceResponseHandler
unmarshallHistoryResponse Given an HttpResponse object - attempts to deserialize it into a HistoryResponse object
unmarshallIngestResponse(HttpResponse) - Static method in class net.snowflake.ingest.connection.ServiceResponseHandler
unmarshallIngestResponse Given an HttpResponse object - attempts to deserialize it into an IngestResponse object

V

valueOf(String) - Static method in enum net.snowflake.ingest.connection.IngestStatus
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.snowflake.ingest.connection.IngestStatus
Returns an array containing the constants of this enum type, in the order they are declared.

W

wrapFilepaths(Set<String>) - Static method in class net.snowflake.ingest.SimpleIngestManager
wrapFilepaths - convenience method to take a list of filenames and produce a list of FileWrappers with unset size
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links

Copyright © 2020. All rights reserved.