Skip to content

docs: clarify how to use asynchronous non-blocking Write API#255

Merged
bednar merged 4 commits intomasterfrom
docs/write-api
Aug 12, 2021
Merged

docs: clarify how to use asynchronous non-blocking Write API#255
bednar merged 4 commits intomasterfrom
docs/write-api

Conversation

@bednar
Copy link
Copy Markdown
Contributor

@bednar bednar commented Aug 5, 2021 •
edited
Loading

Closes #167

Proposed Changes

  1. Deprecated com.influxdb.client.InfluxDBClient#getWriteApi() to use com.influxdb.client.InfluxDBClient#makeWriteApi()
  2. Use WriteApiBlocking in simple examples
  3. Added warning if there is to much created WriteApi instances:

There is already created 10 instances of 'WriteApi'. The 'WriteApi' is suppose to run as a singleton and should be reused across threads. Use 'WriteApiBlocking` if you would like to use one-time ingesting.

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • mvn test completes successfully
  • Commit messages are in semantic format
  • Sign CLA (if not already signed)

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Aug 5, 2021 •
edited
Loading

Codecov Report

Merging #255 (6c66806) into master (b1dadbd) will decrease coverage by 0.09%.
The diff coverage is 44.44%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #255      +/-   ##
============================================
- Coverage     89.26%   89.17%   -0.10%     
  Complexity      449      449              
============================================
  Files           145      145              
  Lines          5767     5773       +6     
  Branches        271      272       +1     
============================================
  Hits           5148     5148              
- Misses          540      545       +5     
- Partials         79       80       +1
Impacted Files Coverage Δ
...m/influxdb/client/internal/InfluxDBClientImpl.java 87.27% <28.57%> (-10.69%) ⬇️
...a/com/influxdb/client/osgi/LineProtocolWriter.java 100.00% <100.00%> (ø)
...ain/java/com/influxdb/client/osgi/PointWriter.java 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b1dadbd...6c66806. Read the comment docs.

@bednar bednar marked this pull request as ready for review August 5, 2021 10:47
@bednar bednar requested a review from rhajek August 5, 2021 10:47
This was referenced Aug 5, 2021
Closed
Merged
@bednar bednar merged commit 8e1b4f3 into master Aug 12, 2021
@bednar bednar deleted the docs/write-api branch August 12, 2021 13:38
@bednar bednar added this to the 3.2.0 milestone Aug 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@rhajek rhajek rhajek approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

3.2.0

Development

Successfully merging this pull request may close these issues.

Clarify, rename or make clear that getWriteApi will make a new thread

3 participants

@bednar @codecov-commenter @rhajek