Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more detailed javadoc for the drop related api to warn about the … #681

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Add more detailed javadoc for the drop related api to warn about the … #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
702aded
Add more detailed javadoc for the drop related api to warn about the …
sfc-gh-psaha Feb 22, 2024
f6ab27f
Minor update
sfc-gh-psaha Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/main/java/net/snowflake/ingest/streaming/SnowflakeStreamingIngestChannel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ public interface SnowflakeStreamingIngestChannel {
/**
* Close the channel, this function will make sure all the data in this channel is committed
*
* <p>Note that this call with drop=true will delete <a
* href=https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-overview#offset-tokens>Offset
* Token</a> and other state from Snowflake servers unless the channel has already been opened in
sfc-gh-psaha marked this conversation as resolved.
Show resolved Hide resolved
* another client. So only use it if you are completely done ingesting data for this channel. If
* you open a channel with the same name in the future, it will behave like a new channel.
*
* @param drop if true, the channel will be dropped after all data is successfully committed.
* @return a completable future which will be completed when the channel is closed
*/
Expand Down
12 changes: 9 additions & 3 deletions src/main/java/net/snowflake/ingest/streaming/SnowflakeStreamingIngestClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,15 @@ public interface SnowflakeStreamingIngestClient extends AutoCloseable {
/**
* Drop the specified channel on the server using a {@link DropChannelRequest}
*
* <p>Note that this call will blindly drop the latest version of the channel and any pending data
* will be lost. Also see {@link SnowflakeStreamingIngestChannel#close(boolean)} to drop channels
* on close. That approach will drop the local version of the channel and if the channel has been
* <p>Note that this call will <em>blindly</em> drop the latest version of the channel and any
* pending data will be lost. It will also delete <a
* href=https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-overview#offset-tokens>Offset
* Token</a> and other state from Snowflake servers. So only use it if you are completely done
* ingesting data for this channel. If you open a channel with the same name in the future, it
* will behave like a new channel.
*
* <p>Also see {@link SnowflakeStreamingIngestChannel#close(boolean)} to drop channels on close.
* That approach will drop the local version of the channel and if the channel has been
sfc-gh-psaha marked this conversation as resolved.
Show resolved Hide resolved
* concurrently reopened by another client, that version of the channel won't be affected.
*
* @param request the drop channel request
Expand Down
Loading