Skip to content

Commit

Permalink
fix: Update SchemaAwareStreamWriter comment to down recommend it. (#2195
Browse files Browse the repository at this point in the history
)

* fix: update the comment in SchemaAwareStreamWriter about when the feature is actually disabled

* .

* .

* .

* .

* .
  • Loading branch information
yirutang committed Jul 20, 2023
1 parent addbcdf commit 4897c05
Showing 1 changed file with 7 additions and 0 deletions.
Expand Up @@ -43,6 +43,13 @@
* StreamWriter functions, but also provides an additional feature: schema update support, where if
* the BigQuery table schema is updated, users will be able to ingest data on the new schema after
* some time (in order of minutes).
*
* <p>NOTE: The schema update ability will be disabled when you pass in a table schema explicitly
* through the writer. It is recommended that user either use JsonStreamWriter (which fully manages
* table schema) or StreamWriter (which accepts proto format in raw and user will handle the schema
* update event themsevles). If you use this class, you need to be very cautious about possible
* mistmach between the writer's schema and the input data, any mismatch of the two will cause data
* corruption.
*/
public class SchemaAwareStreamWriter<T> implements AutoCloseable {
private static final Logger LOG = Logger.getLogger(SchemaAwareStreamWriter.class.getName());
Expand Down

0 comments on commit 4897c05

Please sign in to comment.