datajoint-python
datajoint-python copied to clipboard
server setting check function
trafficstars
Feature Request
Problem
New users often hit server configuration issues such as too small max_allowed_packet, etc.
Often, the setup/configuration process goes like this:
- user tries datajoint
- user hits server config problem (max_allowed_packet is a big one, also others)
- user asks public support channel for resolution
- we advise checking our reference configuration from mysql-docker
- user fixes issue, or then asks follow up questions about how to configure server
- repeat 2-5 until issue resolved or user gives up
it would be nice if we could distill recommendations & documentation pointers into a 'check' function which advises on expected configuration settings.
Requirements
check function checking key settings important to datajoint python
Justification
easier capturing/communication of expected server configurations, reduction in new user frustrations
This is a good request.
To build on this specification:
- The recommended, optimized MySQL settings for DataJoint use can be found here.
- This could be implemented in
datajoint.admin.pywith a function exposed to the package perhaps asdj.audit_server_configuration(). - Specific configurations that differ from recommended could be reported in a nice summary.