kevinjqliu commented on code in PR #886:
URL: https://github.com/apache/iceberg-python/pull/886#discussion_r1665991459


##########
mkdocs/docs/configuration.md:
##########
@@ -222,6 +222,12 @@ catalog:
     uri: sqlite:////tmp/pyiceberg.db
 ```
 
+| Key           | Example                                                      
| Default | Description                                                         
                                                                                
                                           |
+| ------------- | ------------------------------------------------------------ 
| ------- | 
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 |
+| uri           | postgresql+psycopg2://username:password@localhost/mydatabase 
|         | SQLAlchemy backend URL for the catalog database (see [documentation 
for URL 
format](https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls))
                                |
+| echo          | true                                                         
| false   | SQLAlchemy engine [echo 
param](https://docs.sqlalchemy.org/en/20/core/engines.html#sqlalchemy.create_engine.params.echo)
 to log all statements to the default log handler                      |
+| pool_pre_ping | true                                                         
| false   | SQLAlchemy engine [pool_pre_ping 
param](https://docs.sqlalchemy.org/en/20/core/engines.html#sqlalchemy.create_engine.params.pool_pre_ping)
 to test connections for liveness upon each checkout |

Review Comment:
   > By leaking implementation details through the public API (something that 
we're already doing by using the same naming) we tie it to SqlAlchemy.
   
   From a public API standpoint, I agree with this statement. 
   For the public API of `SQL catalog`, we should keep the same convention. 
   But it looks like this particular table is part of the `SQLite` section, so 
I think it's fine to have SqlAlchemy-specific key/value here.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org

Reply via email to