Skip to content

Commit 33783ff

Browse files
committed
added stuff to docstrings
1 parent 6a5f365 commit 33783ff

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

pandas/core/generic.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2862,6 +2862,21 @@ def to_sql(
28622862
28632863
Details and a sample callable implementation can be found in the
28642864
section :ref:`insert method <io.sql.method>`.
2865+
hints : dict[str, str], optional
2866+
Dictionary of SQL hints to optimize insertion performance, keyed by
2867+
database dialect name (e.g., 'oracle', 'mysql', 'postgresql', 'mssql').
2868+
Each value should be a complete hint string formatted exactly as required
2869+
by the target database. The user is responsible for providing correctly
2870+
formatted hint strings.
2871+
2872+
Examples: ``{'oracle': '/*+ APPEND PARALLEL(4) */', 'mysql': 'DELAYED'}``
2873+
2874+
.. note::
2875+
- Hints are database-specific and ignored for unsupported dialects.
2876+
- SQLite raises a ``UserWarning`` (hints not supported).
2877+
- ADBC connections raise ``NotImplementedError``.
2878+
2879+
.. versionadded:: 3.0.0
28652880
28662881
Returns
28672882
-------

0 commit comments

Comments
 (0)