PageRenderTime 21ms CodeModel.GetById 7ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/javadoc/com/yahoo/ycsb/Client.html

https://github.com/lehmannro/YCSB
HTML | 386 lines | 316 code | 46 blank | 24 comment | 0 complexity | d2817b0987675543fe0f359003b2a297 MD5 | raw file
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_03) on Wed May 12 14:51:52 PDT 2010 -->
  6. <TITLE>
  7. Client
  8. </TITLE>
  9. <META NAME="date" CONTENT="2010-05-12">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="Client";
  16. }
  17. }
  18. </SCRIPT>
  19. <NOSCRIPT>
  20. </NOSCRIPT>
  21. </HEAD>
  22. <BODY BGCOLOR="white" onload="windowTitle();">
  23. <HR>
  24. <!-- ========= START OF TOP NAVBAR ======= -->
  25. <A NAME="navbar_top"><!-- --></A>
  26. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  27. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  28. <TR>
  29. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  30. <A NAME="navbar_top_firstrow"><!-- --></A>
  31. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  32. <TR ALIGN="center" VALIGN="top">
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  36. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  40. </TR>
  41. </TABLE>
  42. </TD>
  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  44. </EM>
  45. </TD>
  46. </TR>
  47. <TR>
  48. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  49. &nbsp;<A HREF="../../../com/yahoo/ycsb/BasicDB.html" title="class in com.yahoo.ycsb"><B>PREV CLASS</B></A>&nbsp;
  50. &nbsp;<A HREF="../../../com/yahoo/ycsb/CommandLine.html" title="class in com.yahoo.ycsb"><B>NEXT CLASS</B></A></FONT></TD>
  51. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  52. <A HREF="../../../index.html?com/yahoo/ycsb/Client.html" target="_top"><B>FRAMES</B></A> &nbsp;
  53. &nbsp;<A HREF="Client.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  54. &nbsp;<SCRIPT type="text/javascript">
  55. <!--
  56. if(window==top) {
  57. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  58. }
  59. //-->
  60. </SCRIPT>
  61. <NOSCRIPT>
  62. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  63. </NOSCRIPT>
  64. </FONT></TD>
  65. </TR>
  66. <TR>
  67. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  68. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  71. </TR>
  72. </TABLE>
  73. <A NAME="skip-navbar_top"></A>
  74. <!-- ========= END OF TOP NAVBAR ========= -->
  75. <HR>
  76. <!-- ======== START OF CLASS DATA ======== -->
  77. <H2>
  78. <FONT SIZE="-1">
  79. com.yahoo.ycsb</FONT>
  80. <BR>
  81. Class Client</H2>
  82. <PRE>
  83. java.lang.Object
  84. <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.yahoo.ycsb.Client</B>
  85. </PRE>
  86. <HR>
  87. <DL>
  88. <DT><PRE>public class <B>Client</B><DT>extends java.lang.Object</DL>
  89. </PRE>
  90. <P>
  91. Main class for executing YCSB.
  92. <P>
  93. <P>
  94. <HR>
  95. <P>
  96. <!-- =========== FIELD SUMMARY =========== -->
  97. <A NAME="field_summary"><!-- --></A>
  98. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  99. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  100. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  101. <B>Field Summary</B></FONT></TH>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  105. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
  106. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#INSERT_COUNT_PROPERTY">INSERT_COUNT_PROPERTY</A></B></CODE>
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates how many inserts to do, if less than recordcount.</TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#OPERATION_COUNT_PROPERTY">OPERATION_COUNT_PROPERTY</A></B></CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  119. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
  120. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#RECORD_COUNT_PROPERTY">RECORD_COUNT_PROPERTY</A></B></CODE>
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  126. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
  127. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#WORKLOAD_PROPERTY">WORKLOAD_PROPERTY</A></B></CODE>
  128. <BR>
  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  130. </TR>
  131. </TABLE>
  132. &nbsp;
  133. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  134. <A NAME="constructor_summary"><!-- --></A>
  135. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  136. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  137. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  138. <B>Constructor Summary</B></FONT></TH>
  139. </TR>
  140. <TR BGCOLOR="white" CLASS="TableRowColor">
  141. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#Client()">Client</A></B>()</CODE>
  142. <BR>
  143. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  144. </TR>
  145. </TABLE>
  146. &nbsp;
  147. <!-- ========== METHOD SUMMARY =========== -->
  148. <A NAME="method_summary"><!-- --></A>
  149. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  150. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  151. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  152. <B>Method Summary</B></FONT></TH>
  153. </TR>
  154. <TR BGCOLOR="white" CLASS="TableRowColor">
  155. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  156. <CODE>static&nbsp;boolean</CODE></FONT></TD>
  157. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#checkRequiredProperties(java.util.Properties)">checkRequiredProperties</A></B>(java.util.Properties&nbsp;props)</CODE>
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  160. </TR>
  161. <TR BGCOLOR="white" CLASS="TableRowColor">
  162. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  163. <CODE>static&nbsp;void</CODE></FONT></TD>
  164. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
  165. <BR>
  166. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  167. </TR>
  168. <TR BGCOLOR="white" CLASS="TableRowColor">
  169. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  170. <CODE>static&nbsp;void</CODE></FONT></TD>
  171. <TD><CODE><B><A HREF="../../../com/yahoo/ycsb/Client.html#usageMessage()">usageMessage</A></B>()</CODE>
  172. <BR>
  173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  174. </TR>
  175. </TABLE>
  176. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  177. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  178. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  179. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  180. </TR>
  181. <TR BGCOLOR="white" CLASS="TableRowColor">
  182. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  183. </TR>
  184. </TABLE>
  185. &nbsp;
  186. <P>
  187. <!-- ============ FIELD DETAIL =========== -->
  188. <A NAME="field_detail"><!-- --></A>
  189. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  190. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  191. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  192. <B>Field Detail</B></FONT></TH>
  193. </TR>
  194. </TABLE>
  195. <A NAME="OPERATION_COUNT_PROPERTY"><!-- --></A><H3>
  196. OPERATION_COUNT_PROPERTY</H3>
  197. <PRE>
  198. public static final java.lang.String <B>OPERATION_COUNT_PROPERTY</B></PRE>
  199. <DL>
  200. <DL>
  201. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.yahoo.ycsb.Client.OPERATION_COUNT_PROPERTY">Constant Field Values</A></DL>
  202. </DL>
  203. <HR>
  204. <A NAME="RECORD_COUNT_PROPERTY"><!-- --></A><H3>
  205. RECORD_COUNT_PROPERTY</H3>
  206. <PRE>
  207. public static final java.lang.String <B>RECORD_COUNT_PROPERTY</B></PRE>
  208. <DL>
  209. <DL>
  210. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.yahoo.ycsb.Client.RECORD_COUNT_PROPERTY">Constant Field Values</A></DL>
  211. </DL>
  212. <HR>
  213. <A NAME="WORKLOAD_PROPERTY"><!-- --></A><H3>
  214. WORKLOAD_PROPERTY</H3>
  215. <PRE>
  216. public static final java.lang.String <B>WORKLOAD_PROPERTY</B></PRE>
  217. <DL>
  218. <DL>
  219. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.yahoo.ycsb.Client.WORKLOAD_PROPERTY">Constant Field Values</A></DL>
  220. </DL>
  221. <HR>
  222. <A NAME="INSERT_COUNT_PROPERTY"><!-- --></A><H3>
  223. INSERT_COUNT_PROPERTY</H3>
  224. <PRE>
  225. public static final java.lang.String <B>INSERT_COUNT_PROPERTY</B></PRE>
  226. <DL>
  227. <DD>Indicates how many inserts to do, if less than recordcount. Useful for partitioning
  228. the load among multiple servers, if the client is the bottleneck. Additionally, workloads
  229. should support the "insertstart" property, which tells them which record to start at.
  230. <P>
  231. <DL>
  232. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.yahoo.ycsb.Client.INSERT_COUNT_PROPERTY">Constant Field Values</A></DL>
  233. </DL>
  234. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  235. <A NAME="constructor_detail"><!-- --></A>
  236. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  237. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  238. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  239. <B>Constructor Detail</B></FONT></TH>
  240. </TR>
  241. </TABLE>
  242. <A NAME="Client()"><!-- --></A><H3>
  243. Client</H3>
  244. <PRE>
  245. public <B>Client</B>()</PRE>
  246. <DL>
  247. </DL>
  248. <!-- ============ METHOD DETAIL ========== -->
  249. <A NAME="method_detail"><!-- --></A>
  250. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  251. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  252. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  253. <B>Method Detail</B></FONT></TH>
  254. </TR>
  255. </TABLE>
  256. <A NAME="usageMessage()"><!-- --></A><H3>
  257. usageMessage</H3>
  258. <PRE>
  259. public static void <B>usageMessage</B>()</PRE>
  260. <DL>
  261. <DD><DL>
  262. </DL>
  263. </DD>
  264. </DL>
  265. <HR>
  266. <A NAME="checkRequiredProperties(java.util.Properties)"><!-- --></A><H3>
  267. checkRequiredProperties</H3>
  268. <PRE>
  269. public static boolean <B>checkRequiredProperties</B>(java.util.Properties&nbsp;props)</PRE>
  270. <DL>
  271. <DD><DL>
  272. </DL>
  273. </DD>
  274. </DL>
  275. <HR>
  276. <A NAME="main(java.lang.String[])"><!-- --></A><H3>
  277. main</H3>
  278. <PRE>
  279. public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
  280. <DL>
  281. <DD><DL>
  282. </DL>
  283. </DD>
  284. </DL>
  285. <!-- ========= END OF CLASS DATA ========= -->
  286. <HR>
  287. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  288. <A NAME="navbar_bottom"><!-- --></A>
  289. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  290. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  291. <TR>
  292. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  293. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  294. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  295. <TR ALIGN="center" VALIGN="top">
  296. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  297. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  298. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  299. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  300. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  301. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  302. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  303. </TR>
  304. </TABLE>
  305. </TD>
  306. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  307. </EM>
  308. </TD>
  309. </TR>
  310. <TR>
  311. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  312. &nbsp;<A HREF="../../../com/yahoo/ycsb/BasicDB.html" title="class in com.yahoo.ycsb"><B>PREV CLASS</B></A>&nbsp;
  313. &nbsp;<A HREF="../../../com/yahoo/ycsb/CommandLine.html" title="class in com.yahoo.ycsb"><B>NEXT CLASS</B></A></FONT></TD>
  314. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  315. <A HREF="../../../index.html?com/yahoo/ycsb/Client.html" target="_top"><B>FRAMES</B></A> &nbsp;
  316. &nbsp;<A HREF="Client.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  317. &nbsp;<SCRIPT type="text/javascript">
  318. <!--
  319. if(window==top) {
  320. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  321. }
  322. //-->
  323. </SCRIPT>
  324. <NOSCRIPT>
  325. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  326. </NOSCRIPT>
  327. </FONT></TD>
  328. </TR>
  329. <TR>
  330. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  331. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  332. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  333. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  334. </TR>
  335. </TABLE>
  336. <A NAME="skip-navbar_bottom"></A>
  337. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  338. <HR>
  339. </BODY>
  340. </HTML>