Drizzle

Merge lp:~sharan-monikantan/drizzle/drizzletest_API into lp:drizzle

  1. drizzletest_API
  2. Merge into 7.2
Proposed by Patrick Crews
Status: Merged
Approved by: Patrick Crews
Approved revision: 2567
Merged at revision: 2571
Proposed branch: lp:~sharan-monikantan/drizzle/drizzletest_API
Merge into: lp:drizzle
Diff against target: 1041 lines (+1026/-0)
2 files modified
docs/index.rst (+1/-0)
docs/testing/drizzletest_commands.rst (+1025/-0)
To merge this branch: bzr merge lp:~sharan-monikantan/drizzle/drizzletest_API
Reviewer Review Type Date Requested Status
Patrick Crews Approve
Henrik Ingo Approve
Review via email: mp+114548@code.launchpad.net

Description of the change

Initial documentation for drizzletest language.

This is just a skeleton doc, listing the various functions + how to call them.
No text is available as it is copyrighted.

To post a comment you must log in.
Revision history for this message
Henrik Ingo (hingo) wrote :

This seems like it is cleanly base on the output of the following command:

cat client/drizzletest.cc | tail -n $((6714-302)) | head -n 80 | sort

{
};
  0
  "append_file",
  "cat_file",
  "change_user",
  "character_set",
  "chmod",
  "connect",
  "connection",
const char *command_names[]=
  "copy_file",
  "dec",
<cut>
  "system",
  "vertical_results",
  "wait_for_slave_to_stop",
  "while",
  "write_file",

This is a good skeleton for new dtr documentation.

review: Approve
Revision history for this message
Patrick Crews (patrick-crews) wrote :

Looks good to me too. Thank you very much for the second set of eyes, Henrik!

review: Approve
Revision history for this message
Patrick Crews (patrick-crews) wrote :

ps - thanks to shar for taking this task on. Having this info documented for drizzle should help others write more / better tests (many folks were unaware of many drizzletest functions).

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'docs/index.rst'
2--- docs/index.rst 2012-03-16 23:58:53 +0000
3+++ docs/index.rst 2012-07-12 00:31:22 +0000
4@@ -157,6 +157,7 @@
5 testing/sysbench.rst
6 testing/writing_tests.rst
7 testing/dbqp.rst
8+ testing/drizzletest_commands.rst
9
10 Indices and tables
11 ==================
12
13=== added file 'docs/testing/drizzletest_commands.rst'
14--- docs/testing/drizzletest_commands.rst 1970-01-01 00:00:00 +0000
15+++ docs/testing/drizzletest_commands.rst 2012-07-12 00:31:22 +0000
16@@ -0,0 +1,1025 @@
17+Drizzletest Commands
18+====================
19+
20+The commands that are endorsed in Drizzletest are delineated in the following documentation. Examples are given for the commands. Browse **tests/t** for more examples.
21+
22+.. note:: The commands are not case sensitive
23+
24+List of commands
25+----------------
26+
27+* :ref:`append_file`
28+* :ref:`cat_file`
29+* :ref:`change_user`
30+* :ref:`character_set`
31+* :ref:`chmod`
32+* :ref:`connect`
33+* :ref:`connection`
34+* :ref:`copy_file`
35+* :ref:`dec`
36+* :ref:`delimiter`
37+* :ref:`die`
38+* :ref:`diff_files`
39+* :ref:`dirty_close`
40+* :ref:`disable/enable_abort_on_error`
41+* :ref:`disable/enable_connect_log`
42+* :ref:`disable/enable_info`
43+* :ref:`disable/enable_metadata`
44+* :ref:`disable/enable_parsing`
45+* :ref:`disable/enable_ps_protocol`
46+* :ref:`disable/enable_query_log`
47+* :ref:`disable/enable_reconnect`
48+* :ref:`disable/enable_result_log`
49+* :ref:`disable/enable_rpl_parse`
50+* :ref:`disable/enable_warnings`
51+* :ref:`disconnect`
52+* :ref:`echo`
53+* :ref:`end`
54+* :ref:`end_timer`
55+* :ref:`error`
56+* :ref:`eval`
57+* :ref:`exec`
58+* :ref:`exit`
59+* :ref:`file_exists`
60+* :ref:`horizontal_results`
61+* :ref:`if`
62+* :ref:`inc`
63+* :ref:`let`
64+* :ref:`mkdir`
65+* :ref:`list_files`
66+* :ref:`list_files_append_file`
67+* :ref:`list_files_write_file`
68+* :ref:`lowercase_result`
69+* :ref:`move_file`
70+* :ref:`perl`
71+* :ref:`ping`
72+* :ref:`query`
73+* :ref:`query_get_value`
74+* :ref:`query_horizontal`
75+* :ref:`query_vertical`
76+* :ref:`real_sleep`
77+* :ref:`reap`
78+* :ref:`remove_file`
79+* :ref:`remove_files_wildcard`
80+* :ref:`replace_column`
81+* :ref:`replace_regex`
82+* :ref:`replace_result`
83+* :ref:`require`
84+* :ref:`result`
85+* :ref:`rmdir`
86+* :ref:`save_master_pos`
87+* :ref:`send`
88+* :ref:`send_eval`
89+* :ref:`send_quit`
90+* :ref:`shutdown_server`
91+* :ref:`skip`
92+* :ref:`sleep`
93+* :ref:`sorted_result`
94+* :ref:`source`
95+* :ref:`start_timer`
96+* :ref:`sync_slave_with_master`
97+* :ref:`sync_with_master`
98+* :ref:`system`
99+* :ref:`vertical_results`
100+* :ref:`wait_for_slave_to_stop`
101+* :ref:`while`
102+* :ref:`write_file`
103+
104+.. _append_file:
105+
106+append_file
107+-----------
108+:Syntax:
109+
110+:program:`append_file file_name [terminator]`
111+
112+:Example:
113+
114+.. code-block:: python
115+
116+.. _cat_file:
117+
118+cat_file
119+--------
120+
121+:Syntax:
122+
123+:program:`cat_file file_name`
124+
125+:Example:
126+
127+.. code-block:: python
128+
129+.. _change_user:
130+
131+change_user
132+-----------
133+
134+:Syntax:
135+
136+:program:`change_user [user_name], [password], [db_name]`
137+
138+:Example:
139+
140+.. code-block:: python
141+
142+.. _character_set:
143+
144+character_set
145+-------------
146+
147+:Syntax:
148+
149+:program:`character_set charset_name`
150+
151+:Example:
152+
153+.. code-block:: python
154+
155+.. _chmod:
156+
157+chmod
158+-----
159+
160+:Syntax:
161+
162+:program:`chmod octal_mode file_name`
163+
164+:Example:
165+
166+.. code-block:: python
167+
168+.. _connect:
169+
170+connect
171+-------
172+
173+:Syntax:
174+
175+:program:`connect (name, host_name, user_name, password, db_name [,port_num [,socket [,options [,default_auth]]]])`
176+
177+:Example:
178+
179+.. code-block:: python
180+
181+.. _connection:
182+
183+connection
184+----------
185+
186+:Syntax:
187+
188+:program:`connection connection_name`
189+
190+:Example:
191+
192+.. code-block:: python
193+
194+.. _copy_file:
195+
196+copy_file
197+---------
198+
199+:Syntax:
200+
201+:program:`copy_file from_file to_file`
202+
203+:Example:
204+
205+.. code-block:: python
206+
207+.. _dec:
208+
209+dec
210+---
211+
212+:Syntax:
213+
214+:program:`dec $variable_name`
215+
216+:Example:
217+
218+.. code-block:: python
219+
220+.. _delimiter:
221+
222+delimiter
223+---------
224+
225+:Syntax:
226+
227+:program:`delimiter string`
228+
229+:Example:
230+
231+.. code-block:: python
232+
233+.. _die:
234+
235+die
236+---
237+
238+:Syntax:
239+
240+:program:`die [message]`
241+
242+:Example:
243+
244+.. code-block:: python
245+
246+.. _diff_files:
247+
248+diff_files
249+----------
250+
251+:Syntax:
252+
253+:program:`diff_files file_name1 file_name2`
254+
255+:Example:
256+
257+.. code-block:: python
258+
259+.. _dirty_close:
260+
261+dirty_close
262+-----------
263+
264+:Syntax:
265+
266+:program:`dirty_close connection_name`
267+
268+.. _disable/enable_abort_on_error:
269+
270+disable/enable_abort_on_error
271+-----------------------------
272+
273+:Syntax:
274+
275+:program:`disable_abort_on_error,enable_abort_on_error`
276+
277+:Example:
278+
279+.. code-block:: python
280+
281+.. _disable/enable_connect_log:
282+
283+disable/enable_connect_log
284+--------------------------
285+
286+:Syntax:
287+
288+:program:`disable_connect_log, enable_connect_log`
289+
290+:Example:
291+
292+.. code-block:: python
293+
294+.. _disable/enable_info:
295+
296+disable/enable_info
297+-------------------
298+
299+:Syntax:
300+
301+:program:`disable_info, enable_info`
302+
303+:Example:
304+
305+.. code-block:: python
306+
307+.. _disable/enable_metadata:
308+
309+disable/enable_metadata
310+-----------------------
311+
312+:Syntax:
313+
314+:program:`disable_metadata, enable_metadata`
315+
316+:Example:
317+
318+.. code-block:: python
319+
320+.. _disable/enable_parsing:
321+
322+disable/enable_parsing
323+----------------------
324+
325+:Syntax:
326+
327+:program:`disable_parsing, enable_parsing`
328+
329+:Example:
330+
331+.. code-block:: python
332+
333+.. _disable/enable_ps_protocol:
334+
335+disable/enable_ps_protocol
336+--------------------------
337+
338+:Syntax:
339+
340+:program:`disable_ps_protocol, enable_ps_protocol`
341+
342+:Example:
343+
344+.. code-block:: python
345+
346+.. _disable/enable_query_log:
347+
348+disable/enable_query_log
349+------------------------
350+
351+:Syntax:
352+
353+:program:`disable_query_log, enable_query_log`
354+
355+:Example:
356+
357+.. code-block:: python
358+
359+.. _disable/enable_reconnect:
360+
361+disable/enable_reconnect
362+------------------------
363+
364+:Syntax:
365+
366+:program:`disable_reconnect, enable_reconnect`
367+
368+:Example:
369+
370+.. code-block:: python
371+
372+.. _disable/enable_result_log:
373+
374+disable/enable_result_log
375+-------------------------
376+
377+:Syntax:
378+
379+:program:`disable_result_log, enable_result_log`
380+
381+:Example:
382+
383+.. code-block:: python
384+
385+.. _disable/enable_rpl_parse:
386+
387+disable/enable_rpl_parse
388+------------------------
389+
390+:Syntax:
391+
392+:program:`disable_rpl_parse, enable_rpl_parse`
393+
394+:Example:
395+
396+.. code-block:: python
397+
398+.. _disable/enable_warnings:
399+
400+disable/enable_warnings
401+-----------------------
402+
403+:Syntax:
404+
405+:program:`disable_warnings, enable_warnings`
406+
407+:Example:
408+
409+.. code-block:: python
410+
411+.. _disconnect:
412+
413+disconnect
414+----------
415+
416+:Syntax:
417+
418+:program:`disconnect connection_name`
419+
420+:Example:
421+
422+.. code-block:: python
423+
424+.. _echo:
425+
426+echo
427+----
428+
429+:Syntax:
430+
431+:program:`echo text`
432+
433+:Example:
434+
435+.. code-block:: python
436+
437+.. _end:
438+
439+end
440+---
441+
442+:Syntax:
443+
444+:program:`end`
445+
446+.. _end_timer:
447+
448+end_timer
449+---------
450+
451+:Syntax:
452+
453+:program:`end_timer`
454+
455+.. _error:
456+
457+error
458+-----
459+
460+:Syntax:
461+
462+:program:`error error_code [,error_code[,...]]`
463+
464+:Example:
465+
466+.. code-block:: python
467+
468+.. _eval:
469+
470+eval
471+----
472+
473+:Syntax:
474+
475+:program:`eval statement`
476+
477+:Example:
478+
479+.. code-block:: python
480+
481+.. _exec:
482+
483+exec
484+----
485+
486+:Syntax:
487+
488+:program:`exec command [arg1[,arg2[,...]]]`
489+
490+:Example:
491+
492+.. code-block:: python
493+
494+.. _exit:
495+
496+exit
497+----
498+
499+:Syntax:
500+
501+:program:`exit`
502+
503+.. _file_exists:
504+
505+file_exists
506+-----------
507+
508+:Syntax:
509+
510+:program:`file_exists file_name`
511+
512+:Example:
513+
514+.. code-block:: python
515+
516+.. _horizontal_results:
517+
518+horizontal_results
519+------------------
520+
521+:Syntax:
522+
523+:program:`horizontal_results`
524+
525+:Example:
526+
527+.. code-block:: python
528+
529+.. _if:
530+
531+if
532+--
533+
534+:Syntax:
535+
536+:program:`if(expr)`
537+
538+:Example:
539+
540+.. code-block:: python
541+
542+.. _inc:
543+
544+inc
545+---
546+
547+:Syntax:
548+
549+:program:`inc $var_name`
550+
551+:Example:
552+
553+.. code-block:: python
554+
555+.. _let:
556+
557+let
558+---
559+
560+:Syntax:
561+
562+:program:`let $var_name = value`
563+
564+:program:`let $var_name = query_get_value(query, col_name, row_num)`
565+
566+:Example:
567+
568+.. code-block:: python
569+
570+.. _mkdir:
571+
572+mkdir
573+-----
574+
575+:Syntax:
576+
577+:program:`mkdir dir_name`
578+
579+:Example:
580+
581+.. code-block:: python
582+
583+.. _list_files:
584+
585+list_files
586+----------
587+
588+:Syntax:
589+
590+:program:`list_files dir_name [pattern]`
591+
592+:Example:
593+
594+.. code-block:: python
595+
596+.. _list_files_append_file:
597+
598+list_files_append_file
599+----------------------
600+
601+:Syntax:
602+
603+:program:`list_files_append_file file_name dir_name [pattern]`
604+
605+:Example:
606+
607+.. code-block:: python
608+
609+.. _list_files_write_file:
610+
611+list_files_write_file
612+---------------------
613+
614+:Syntax:
615+
616+:program:`list_files_write_file file_name dir_name [pattern]`
617+
618+:Example:
619+
620+.. code-block:: python
621+
622+.. _lowercase_result:
623+
624+lowercase_result
625+----------------
626+
627+:Syntax:
628+
629+:program:`lowercase_result`
630+
631+:Example:
632+
633+.. code-block:: python
634+
635+.. _move_file:
636+
637+move_file
638+---------
639+
640+:Syntax:
641+
642+:program:`move_file from_file to_file`
643+
644+:Example:
645+
646+.. code-block:: python
647+
648+.. _perl:
649+
650+perl
651+----
652+
653+:Syntax:
654+
655+:program:`perl [terminator]`
656+
657+:Example:
658+
659+.. code-block:: python
660+
661+.. _ping:
662+
663+ping
664+----
665+
666+:Syntax:
667+
668+:program:`ping`
669+
670+.. _query:
671+
672+query
673+-----
674+
675+:Syntax:
676+
677+:program:`query [statement]`
678+
679+.. _query_get_value:
680+
681+query_get_value
682+---------------
683+
684+:Syntax:
685+
686+:program:`query_get_value(query,col_name,row_num)`
687+
688+:Example:
689+
690+.. code-block:: python
691+
692+.. _query_horizontal:
693+
694+query_horizontal
695+----------------
696+
697+:Syntax:
698+
699+:program:`query_horizontal statement`
700+
701+:Example:
702+
703+.. code-block:: python
704+
705+.. _query_vertical:
706+
707+query_vertical
708+--------------
709+
710+:Syntax:
711+
712+:program:`query_vertical statement`
713+
714+:Example:
715+
716+.. code-block:: python
717+
718+.. _real_sleep:
719+
720+real_sleep
721+----------
722+
723+:Syntax:
724+
725+:program:`real_sleep num`
726+
727+:Example:
728+
729+.. code-block:: python
730+
731+.. _reap:
732+
733+reap
734+----
735+
736+:Syntax:
737+
738+:program:`reap`
739+
740+.. _remove_file:
741+
742+remove_file
743+-----------
744+
745+:Syntax:
746+
747+:program:`remove_file file_name`
748+
749+:Example:
750+
751+.. code-block:: python
752+
753+.. _remove_files_wildcard:
754+
755+remove_files_wildcard
756+---------------------
757+
758+:Syntax:
759+
760+:program:`remove_files_wildcard dir_name [pattern]`
761+
762+:Example:
763+
764+.. code-block:: python
765+
766+.. _replace_column:
767+
768+replace_column
769+--------------
770+
771+:Syntax:
772+
773+:program:`replace_column col_num value [col_num value [,...] ]`
774+
775+:Example:
776+
777+.. code-block:: python
778+
779+.. _replace_regex:
780+
781+replace_regex
782+-------------
783+
784+:Syntax:
785+
786+:program:`replace_regex /pattern/replacement/[i] ...`
787+
788+:Example:
789+
790+.. code-block:: python
791+
792+.. _replace_result:
793+
794+replace_result
795+--------------
796+
797+:Syntax:
798+
799+:program:`replace_result from_val to_val [from_val to_val [...]]`
800+
801+:Example:
802+
803+.. code-block:: python
804+
805+.. _require:
806+
807+require
808+-------
809+
810+:Syntax:
811+
812+:program:`require file_name`
813+
814+:Example:
815+
816+.. code-block:: python
817+
818+.. _result:
819+
820+result
821+------
822+
823+:Syntax:
824+
825+:program:`result file_name`
826+
827+.. _rmdir:
828+
829+rmdir
830+-----
831+
832+:Syntax:
833+
834+:program:`rmdir dir_name`
835+
836+:Example:
837+
838+.. code-block:: python
839+
840+.. _save_master_pos:
841+
842+save_master_pos
843+---------------
844+
845+:Syntax:
846+
847+:program:`save_master_pos`
848+
849+.. _send:
850+
851+send
852+----
853+
854+:Syntax:
855+
856+:program:`send [statement]`
857+
858+:Example:
859+
860+.. code-block:: python
861+
862+.. _send_eval:
863+
864+send_eval
865+---------
866+
867+:Syntax:
868+
869+:program:`send_eval [statement]`
870+
871+:Example:
872+
873+.. code-block:: python
874+
875+.. _send_quit:
876+
877+send_quit
878+---------
879+
880+:Syntax:
881+
882+:program:`send_quit [timeout]`
883+
884+:Example:
885+
886+.. code-block:: python
887+
888+.. _shutdown_server:
889+
890+shutdown_server
891+---------------
892+
893+:Syntax:
894+
895+:program:`shutdown_server [timeout]`
896+
897+:Example:
898+
899+.. code-block:: python
900+
901+.. _skip:
902+
903+skip
904+----
905+
906+:Syntax:
907+
908+:program:`skip [message]`
909+
910+:Example:
911+
912+.. code-block:: python
913+
914+.. _sleep:
915+
916+sleep
917+-----
918+
919+:Syntax:
920+
921+:program:`sleep num`
922+
923+:Example:
924+
925+.. code-block:: python
926+
927+.. _sorted_result:
928+
929+sorted_result
930+-------------
931+
932+:Syntax:
933+
934+:program:`sorted_result`
935+
936+:Example:
937+
938+.. code-block:: python
939+
940+.. _source:
941+
942+source
943+------
944+
945+:Syntax:
946+
947+:program:`source file_name`
948+
949+:Example:
950+
951+.. code-block:: python
952+
953+.. _start_timer:
954+
955+start_timer
956+-----------
957+
958+:Syntax:
959+
960+:program:`start_timer`
961+
962+.. _sync_slave_with_master:
963+
964+sync_slave_with_master
965+----------------------
966+
967+:Syntax:
968+
969+:program:`sync_slave_with_master [connection_name]`
970+
971+.. _sync_with_master:
972+
973+sync_with_master
974+----------------
975+
976+:Syntax:
977+
978+:program:`sync_with_master offset`
979+
980+.. _system:
981+
982+system
983+------
984+
985+:Syntax:
986+
987+:program:`system command [arg1[,arg2[,...]]]`
988+
989+:Example:
990+
991+.. code-block:: python
992+
993+.. _vertical_results:
994+
995+vertical_results
996+----------------
997+
998+:Syntax:
999+
1000+:program:`vertical_results`
1001+
1002+:Example:
1003+
1004+.. code-block:: python
1005+
1006+.. _wait_for_slave_to_stop:
1007+
1008+wait_for_slave_to_stop
1009+----------------------
1010+
1011+:Syntax:
1012+
1013+:program:`wait_for_slave_to_stop`
1014+
1015+.. _while:
1016+
1017+while
1018+-----
1019+
1020+:Syntax:
1021+
1022+:program:`while(expr)`
1023+
1024+:Example:
1025+
1026+.. code-block:: python
1027+
1028+.. _write_file:
1029+
1030+write_file
1031+----------
1032+
1033+:Syntax:
1034+
1035+:program:`write_file file_name [terminator]`
1036+
1037+:Example:
1038+
1039+.. code-block:: python
1040+
1041+

Subscribers

People subscribed via source and target branches

to all changes: