{"id":1258,"date":"2022-11-30T14:54:19","date_gmt":"2022-11-30T14:54:19","guid":{"rendered":"https:\/\/www.hammerdb.com\/blog\/?p=1258"},"modified":"2022-12-02T11:11:59","modified_gmt":"2022-12-02T11:11:59","slug":"hammerdb-v4-6-new-features-pt1-python-cli-interface","status":"publish","type":"post","link":"https:\/\/www.hammerdb.com\/blog\/uncategorized\/hammerdb-v4-6-new-features-pt1-python-cli-interface\/","title":{"rendered":"HammerDB v4.6 New Features Pt1: Python CLI Interface"},"content":{"rendered":"

From version v4.6 HammerDB allows you to run the Command Line Interface in both interactive and scripted sessions using a Python interpreter as an alternative to the default Tcl environment on both Linux and Windows.<\/p>\n

Python Version Dependency<\/h3>\n

HammerDB will rely on the system installed Python interpreter and at a specific version as described in the following table. On Windows you need to install Python from www.python.org rather than the Windows app store to ensure that the required libraries are installed.<\/p>\n\n\n\n\n\n
Linux<\/td>\n3.8<\/td>\n<\/tr>\n
Red Hat Enterprise Linux<\/td>\n3.6<\/td>\n<\/tr>\n
Windows<\/td>\n3.10<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

If you need a different version of Python you can build HammerDB from source as detailed in the documentation to use any version of Python 3 that you wish.<\/p>\n

Starting the CLI in Python Mode<\/h3>\n

To start HammerDB in Python mode run the hammerdbcli tool with “py” or “python” as the first argument.\u00a0 HammerDB will show the prompt\u00a0 “hammerdb>>>” to indicate that it is running a Python interpreter.<\/p>\n

\n\t\t\t
\n
\n
\n
<\/div>\n
<\/div>\n
<\/div>\n <\/div>\n
\n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n 
<\/p>\n
$ .\/hammerdbcli py\r\nHammerDB CLI v4.6 \r\nCopyright (C) 2003-2022 Steve Shaw \r\nType \"help()\" for a list of commands \r\nhammerdb>>><\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
On Windows firstly open a CMD shell, navigate to HammerDB directory and run the same command as on Linux.<\/p>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
C:\\Program Files\\HammerDB-4.6>hammerdbcli py \r\nHammerDB CLI v4.6 \r\nCopyright (C) 2003-2022 Steve Shaw \r\nType \"help()\" for a list of commands \r\nhammerdb>>><\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
In this mode HammerDB will now accept commands and scripts in Python format enabling integration with an existing Python environment. A Python script can be run from an external command or script using the auto argument and a .py extension to the script.<\/p>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
hammerdbcli py auto autorunbuild.py<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
or the script run from the interactive prompt using the source command.<\/p>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
hammerdb>>>source('cliexample.py')<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
The HammerDB commands are accessed as Python functions with all arguments given as strings or integers where appropriate.<\/p>\n
\n\t\t\t
\n                
\n                    
\n                        
<\/div>\n                        
<\/div>\n                        
<\/div>\n                    <\/div>\n                    
\n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
<\/p>\n
print(\"SETTING CONFIGURATION\") \r\ndbset('db','mssqls') \r\ndiset('tpcc','mssqls_driver','timed') \r\ndiset('tpcc','mssqls_rampup',0) \r\ndiset('tpcc','mssqls_duration',1) \r\nvuset('logtotemp',1) \r\nloadscript() \r\nprint(\"SEQUENCE STARTED\") \r\nfor z in [1,2,4]: \u00a0\u00a0\u00a0 \r\n     print(z,\" VU TEST\") \u00a0\u00a0\u00a0 \r\n     vuset('vu',z) \u00a0\u00a0\u00a0 \r\n     vucreate() \u00a0\u00a0\u00a0 \r\n     vurun() \u00a0\u00a0\u00a0 \r\n     vudestroy() \r\n\r\nprint(\"TEST SEQUENCE COMPLETE\")<\/pre>\n
<\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
Running this script returns output as follows using the Python loop to drive HammerDB.<\/p>\n
hammerdb>>>source('cliexample.py')\r\nhammerdb>>>SETTING CONFIGURATION\r\nDatabase set to MSSQLServer\r\nValue timed for tpcc:mssqls_driver is the same as existing value timed, no change made\r\nChanged tpcc:mssqls_rampup from 2 to 0 for MSSQLServer\r\nChanged tpcc:mssqls_duration from 5 to 1 for MSSQLServer\r\nScript loaded, Type \"print script\" to view\r\nSEQUENCE STARTED\r\n1 VU TEST\r\nVuser 1 created MONITOR - WAIT IDLE\r\nVuser 2 created - WAIT IDLE\r\nLogging activated\r\nto C:\/Users\/Hdb\/AppData\/Local\/Temp\/hammerdb.log\r\n2 Virtual Users Created with Monitor VU\r\nVuser 1:RUNNING\r\nVuser 1:Initializing xtprof time profiler\r\nVuser 1:Beginning rampup time of 0 minutes\r\nVuser 1:Rampup complete, Taking start Transaction Count.\r\nVuser 1:Timing test period of 1 in minutes\r\nVuser 2:RUNNING\r\nVuser 2:Initializing xtprof time profiler\r\nVuser 2:Processing 10000000 transactions with output suppressed...\r\nVuser 1:1 ...,\r\nVuser 1:Test complete, Taking end Transaction Count.\r\nVuser 1:1 Active Virtual Users configured\r\nVuser 1:TEST RESULT : System achieved 39945 NOPM from 92893 SQL Server TPM\r\nVuser 1:Gathering timing data from Active Virtual Users...\r\nVuser 2:FINISHED SUCCESS\r\nVuser 1:Calculating timings...\r\nVuser 1:Writing timing data to C:\/Users\/Hdb\/AppData\/Local\/Temp\/hdbxtprofile.log\r\nVuser 1:FINISHED SUCCESS\r\nALL VIRTUAL USERS COMPLETE\r\nvudestroy success\r\n2 VU TEST\r\nVuser 1 created MONITOR - WAIT IDLE\r\nVuser 2 created - WAIT IDLE\r\nVuser 3 created - WAIT IDLE\r\nLogging activated\r\nto C:\/Users\/Hdb\/AppData\/Local\/Temp\/hammerdb.log\r\n3 Virtual Users Created with Monitor VU\r\nVuser 1:RUNNING\r\nVuser 1:Initializing xtprof time profiler\r\nVuser 1:Beginning rampup time of 0 minutes\r\nVuser 1:Rampup complete, Taking start Transaction Count.\r\nVuser 1:Timing test period of 1 in minutes\r\nVuser 2:RUNNING\r\nVuser 2:Initializing xtprof time profiler\r\nVuser 2:Processing 10000000 transactions with output suppressed...\r\nVuser 3:RUNNING\r\nVuser 3:Initializing xtprof time profiler\r\nVuser 3:Processing 10000000 transactions with output suppressed...\r\nVuser 1:1 ...,\r\nVuser 1:Test complete, Taking end Transaction Count.\r\nVuser 1:2 Active Virtual Users configured\r\nVuser 1:TEST RESULT : System achieved 81178 NOPM from 189455 SQL Server TPM\r\nVuser 1:Gathering timing data from Active Virtual Users...\r\nVuser 3:FINISHED SUCCESS\r\nVuser 2:FINISHED SUCCESS\r\nVuser 1:Calculating timings...\r\nVuser 1:Writing timing data to C:\/Users\/Hdb\/AppData\/Local\/Temp\/hdbxtprofile.log\r\nVuser 1:FINISHED SUCCESS\r\nALL VIRTUAL USERS COMPLETE\r\nvudestroy success\r\n4 VU TEST\r\nVuser 1 created MONITOR - WAIT IDLE\r\nVuser 2 created - WAIT IDLE\r\nVuser 3 created - WAIT IDLE\r\nVuser 4 created - WAIT IDLE\r\nVuser 5 created - WAIT IDLE\r\nLogging activated\r\nto C:\/Users\/Hdb\/AppData\/Local\/Temp\/hammerdb.log\r\n5 Virtual Users Created with Monitor VU\r\nVuser 1:RUNNING\r\nVuser 1:Initializing xtprof time profiler\r\nVuser 1:Beginning rampup time of 0 minutes\r\nVuser 1:Rampup complete, Taking start Transaction Count.\r\nVuser 1:Timing test period of 1 in minutes\r\nVuser 2:RUNNING\r\nVuser 2:Initializing xtprof time profiler\r\nVuser 2:Processing 10000000 transactions with output suppressed...\r\nVuser 3:RUNNING\r\nVuser 3:Initializing xtprof time profiler\r\nVuser 3:Processing 10000000 transactions with output suppressed...\r\nVuser 4:RUNNING\r\nVuser 4:Initializing xtprof time profiler\r\nVuser 4:Processing 10000000 transactions with output suppressed...\r\nVuser 5:RUNNING\r\nVuser 5:Initializing xtprof time profiler\r\nVuser 5:Processing 10000000 transactions with output suppressed...\r\nVuser 1:1 ...,\r\nVuser 1:Test complete, Taking end Transaction Count.\r\nVuser 1:4 Active Virtual Users configured\r\nVuser 1:TEST RESULT : System achieved 118762 NOPM from 276763 SQL Server TPM\r\nVuser 1:Gathering timing data from Active Virtual Users...\r\nVuser 5:FINISHED SUCCESS\r\nVuser 4:FINISHED SUCCESS\r\nVuser 3:FINISHED SUCCESS\r\nVuser 2:FINISHED SUCCESS\r\nVuser 1:Calculating timings...\r\nVuser 1:Writing timing data to C:\/Users\/Hdb\/AppData\/Local\/Temp\/hdbxtprofile.log\r\nVuser 1:FINISHED SUCCESS\r\nALL VIRTUAL USERS COMPLETE\r\nvudestroy success\r\nTEST SEQUENCE COMPLETE\r\nhammerdb>>><\/pre>\n
Python Performance and the GIL<\/h3>\n
You should already be aware that due to the Python GIL impacting multithreading performance it is not possible to drive a high-performance database workload directly from Python.<\/p>\n
Why Tcl is 700% faster than Python for database benchmarking<\/a><\/p><\/blockquote>\n