Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

Hints to overload protection and ANALYZE command #325

Merged
merged 2 commits into from
Nov 16, 2023

Conversation

ckurze
Copy link

@ckurze ckurze commented Nov 15, 2023

Summary of the changes / Why this is an improvement

  • Improvement of documentation: execute ANALYZE statements after (large) inserts and hints to overload protection

Checklist

  • Link to issue this PR refers to (if applicable):
  • CLA is signed

.. _refresh_interval: https://crate.io/docs/crate/reference/en/latest/sql/reference/create_table.html#refresh-interval
.. _Solid-State Drives: https://en.wikipedia.org/wiki/Solid-state_drive
.. _surrogate primary key: https://en.wikipedia.org/wiki/Surrogate_key
.. _system column: https://crate.io/docs/crate/reference/en/latest/sql/administration/system_columns.html
.. _translog.durability: https://crate.io/docs/crate/reference/en/latest/sql/reference/create_table.html#translog-durability
.. _turning column indexes off: https://crate.io/docs/crate/reference/en/latest/sql/ddl/indices_full_search.html#disable-indexing
:: _Overload Protection: https://cratedb.com/docs/crate/reference/en/latest/config/cluster.html#overload-protection
Copy link
Member

@amotl amotl Nov 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a better way to link to other Spinx documentation, like, in this case:

:ref:`crate-reference:overload_protection`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/performance/inserts/tuning.rst Outdated Show resolved Hide resolved
docs/performance/inserts/tuning.rst Outdated Show resolved Hide resolved
docs/performance/inserts/tuning.rst Outdated Show resolved Hide resolved
docs/performance/inserts/tuning.rst Outdated Show resolved Hide resolved
docs/performance/inserts/tuning.rst Outdated Show resolved Hide resolved
@ckurze
Copy link
Author

ckurze commented Nov 16, 2023

Build still seems to fail due to warnings and broken links (r-project.org seems to be down at the moment?)

WARNING: myst-parser 0.12.10 does not provide the extra 'linkify'

cc: @amotl

@amotl amotl force-pushed the ckurze/doc-insert-performance branch from 708efcb to 4e0c158 Compare November 16, 2023 10:06
@amotl amotl merged commit 21d127d into master Nov 16, 2023
4 checks passed
@amotl amotl deleted the ckurze/doc-insert-performance branch November 16, 2023 10:10
@@ -307,3 +311,4 @@ throughput of your cluster with different setups and under different loads.
.. _translog.durability: https://crate.io/docs/crate/reference/en/latest/sql/reference/create_table.html#translog-durability
.. _UNNEST reference documentation: https://crate.io/docs/crate/reference/en/latest/sql/statements/insert.html?highlight=unnest#description
.. _UNNEST: https://crate.io/docs/crate/reference/en/latest/sql/table_functions.html#unnest-array-array
.. _Overload Protection: https://cratedb.com/docs/crate/reference/en/latest/config/cluster.html#overload-protection
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JFYI: We usually sort those alphabetically, instead of just adding new links at the bottom.

Comment on lines +103 to +116
Overload Protection
-------------------

The `Overload Protection`_ settings control how many resources operations like
``INSERT INTO FROM QUERY`` or ``COPY`` can use.

The default values serve as a starting point for an algorithm that dynamically
adapts the effective concurrency limit based on the round-trip time of requests.
Whenever one of these settings is updated, the previously calculated effective
concurrency is reset.

Please update the settings accordingly, especially if you are benchmarking insert
performance.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few trailing spaces sneaked in here. Can I humbly ask you to configure your editor to strip those, or take extra care when committing?

image

@amotl
Copy link
Member

amotl commented Nov 16, 2023

Hi. I've forward-ported your patch to the new instance of this documentation, also addressing a few suggestions right away. Thank you again.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants