Dapper.xml 68 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Dapper</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Dapper.CommandFlags">
  8. <summary>
  9. Additional state flags that control command behaviour
  10. </summary>
  11. </member>
  12. <member name="F:Dapper.CommandFlags.None">
  13. <summary>
  14. No additional flags
  15. </summary>
  16. </member>
  17. <member name="F:Dapper.CommandFlags.Buffered">
  18. <summary>
  19. Should data be buffered before returning?
  20. </summary>
  21. </member>
  22. <member name="F:Dapper.CommandFlags.Pipelined">
  23. <summary>
  24. Can async queries be pipelined?
  25. </summary>
  26. </member>
  27. <member name="F:Dapper.CommandFlags.NoCache">
  28. <summary>
  29. Should the plan cache be bypassed?
  30. </summary>
  31. </member>
  32. <member name="T:Dapper.CommandDefinition">
  33. <summary>
  34. Represents the key aspects of a sql operation
  35. </summary>
  36. </member>
  37. <member name="P:Dapper.CommandDefinition.CommandText">
  38. <summary>
  39. The command (sql or a stored-procedure name) to execute
  40. </summary>
  41. </member>
  42. <member name="P:Dapper.CommandDefinition.Parameters">
  43. <summary>
  44. The parameters associated with the command
  45. </summary>
  46. </member>
  47. <member name="P:Dapper.CommandDefinition.Transaction">
  48. <summary>
  49. The active transaction for the command
  50. </summary>
  51. </member>
  52. <member name="P:Dapper.CommandDefinition.CommandTimeout">
  53. <summary>
  54. The effective timeout for the command
  55. </summary>
  56. </member>
  57. <member name="P:Dapper.CommandDefinition.CommandType">
  58. <summary>
  59. The type of command that the command-text represents
  60. </summary>
  61. </member>
  62. <member name="P:Dapper.CommandDefinition.Buffered">
  63. <summary>
  64. Should data be buffered before returning?
  65. </summary>
  66. </member>
  67. <member name="P:Dapper.CommandDefinition.AddToCache">
  68. <summary>
  69. Should the plan for this query be cached?
  70. </summary>
  71. </member>
  72. <member name="P:Dapper.CommandDefinition.Flags">
  73. <summary>
  74. Additional state flags against this command
  75. </summary>
  76. </member>
  77. <member name="P:Dapper.CommandDefinition.Pipelined">
  78. <summary>
  79. Can async queries be pipelined?
  80. </summary>
  81. </member>
  82. <member name="M:Dapper.CommandDefinition.#ctor(System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType},Dapper.CommandFlags,System.Threading.CancellationToken)">
  83. <summary>
  84. Initialize the command definition
  85. </summary>
  86. </member>
  87. <member name="P:Dapper.CommandDefinition.CancellationToken">
  88. <summary>
  89. For asynchronous operations, the cancellation-token
  90. </summary>
  91. </member>
  92. <member name="T:Dapper.SqlMapper">
  93. <summary>
  94. Dapper, a light weight object mapper for ADO.NET
  95. </summary>
  96. </member>
  97. <member name="T:Dapper.SqlMapper.IDynamicParameters">
  98. <summary>
  99. Implement this interface to pass an arbitrary db specific set of parameters to Dapper
  100. </summary>
  101. </member>
  102. <member name="M:Dapper.SqlMapper.IDynamicParameters.AddParameters(System.Data.IDbCommand,Dapper.SqlMapper.Identity)">
  103. <summary>
  104. Add all the parameters needed to the command just before it executes
  105. </summary>
  106. <param name="command">The raw command prior to execution</param>
  107. <param name="identity">Information about the query</param>
  108. </member>
  109. <member name="T:Dapper.SqlMapper.IParameterLookup">
  110. <summary>
  111. Extends IDynamicParameters providing by-name lookup of parameter values
  112. </summary>
  113. </member>
  114. <member name="P:Dapper.SqlMapper.IParameterLookup.Item(System.String)">
  115. <summary>
  116. Get the value of the specified parameter (return null if not found)
  117. </summary>
  118. </member>
  119. <member name="T:Dapper.SqlMapper.IParameterCallbacks">
  120. <summary>
  121. Extends IDynamicParameters with facilities for executing callbacks after commands have completed
  122. </summary>
  123. </member>
  124. <member name="M:Dapper.SqlMapper.IParameterCallbacks.OnCompleted">
  125. <summary>
  126. Invoked when the command has executed
  127. </summary>
  128. </member>
  129. <member name="T:Dapper.SqlMapper.ICustomQueryParameter">
  130. <summary>
  131. Implement this interface to pass an arbitrary db specific parameter to Dapper
  132. </summary>
  133. </member>
  134. <member name="M:Dapper.SqlMapper.ICustomQueryParameter.AddParameter(System.Data.IDbCommand,System.String)">
  135. <summary>
  136. Add the parameter needed to the command before it executes
  137. </summary>
  138. <param name="command">The raw command prior to execution</param>
  139. <param name="name">Parameter name</param>
  140. </member>
  141. <member name="T:Dapper.SqlMapper.ITypeHandler">
  142. <summary>
  143. Implement this interface to perform custom type-based parameter handling and value parsing
  144. </summary>
  145. </member>
  146. <member name="M:Dapper.SqlMapper.ITypeHandler.SetValue(System.Data.IDbDataParameter,System.Object)">
  147. <summary>
  148. Assign the value of a parameter before a command executes
  149. </summary>
  150. <param name="parameter">The parameter to configure</param>
  151. <param name="value">Parameter value</param>
  152. </member>
  153. <member name="M:Dapper.SqlMapper.ITypeHandler.Parse(System.Type,System.Object)">
  154. <summary>
  155. Parse a database value back to a typed value
  156. </summary>
  157. <param name="value">The value from the database</param>
  158. <param name="destinationType">The type to parse to</param>
  159. <returns>The typed value</returns>
  160. </member>
  161. <member name="T:Dapper.SqlMapper.UdtTypeHandler">
  162. <summary>
  163. A type handler for data-types that are supported by the underlying provider, but which need
  164. a well-known UdtTypeName to be specified
  165. </summary>
  166. </member>
  167. <member name="M:Dapper.SqlMapper.UdtTypeHandler.#ctor(System.String)">
  168. <summary>
  169. Creates a new instance of UdtTypeHandler with the specified UdtTypeName
  170. </summary>
  171. </member>
  172. <member name="T:Dapper.SqlMapper.TypeHandler`1">
  173. <summary>
  174. Base-class for simple type-handlers
  175. </summary>
  176. </member>
  177. <member name="M:Dapper.SqlMapper.TypeHandler`1.SetValue(System.Data.IDbDataParameter,`0)">
  178. <summary>
  179. Assign the value of a parameter before a command executes
  180. </summary>
  181. <param name="parameter">The parameter to configure</param>
  182. <param name="value">Parameter value</param>
  183. </member>
  184. <member name="M:Dapper.SqlMapper.TypeHandler`1.Parse(System.Object)">
  185. <summary>
  186. Parse a database value back to a typed value
  187. </summary>
  188. <param name="value">The value from the database</param>
  189. <returns>The typed value</returns>
  190. </member>
  191. <member name="T:Dapper.SqlMapper.ITypeMap">
  192. <summary>
  193. Implement this interface to change default mapping of reader columns to type members
  194. </summary>
  195. </member>
  196. <member name="M:Dapper.SqlMapper.ITypeMap.FindConstructor(System.String[],System.Type[])">
  197. <summary>
  198. Finds best constructor
  199. </summary>
  200. <param name="names">DataReader column names</param>
  201. <param name="types">DataReader column types</param>
  202. <returns>Matching constructor or default one</returns>
  203. </member>
  204. <member name="M:Dapper.SqlMapper.ITypeMap.FindExplicitConstructor">
  205. <summary>
  206. Returns a constructor which should *always* be used.
  207. Parameters will be default values, nulls for reference types and zero'd for value types.
  208. Use this class to force object creation away from parameterless constructors you don't control.
  209. </summary>
  210. </member>
  211. <member name="M:Dapper.SqlMapper.ITypeMap.GetConstructorParameter(System.Reflection.ConstructorInfo,System.String)">
  212. <summary>
  213. Gets mapping for constructor parameter
  214. </summary>
  215. <param name="constructor">Constructor to resolve</param>
  216. <param name="columnName">DataReader column name</param>
  217. <returns>Mapping implementation</returns>
  218. </member>
  219. <member name="M:Dapper.SqlMapper.ITypeMap.GetMember(System.String)">
  220. <summary>
  221. Gets member mapping for column
  222. </summary>
  223. <param name="columnName">DataReader column name</param>
  224. <returns>Mapping implementation</returns>
  225. </member>
  226. <member name="T:Dapper.SqlMapper.IMemberMap">
  227. <summary>
  228. Implements this interface to provide custom member mapping
  229. </summary>
  230. </member>
  231. <member name="P:Dapper.SqlMapper.IMemberMap.ColumnName">
  232. <summary>
  233. Source DataReader column name
  234. </summary>
  235. </member>
  236. <member name="P:Dapper.SqlMapper.IMemberMap.MemberType">
  237. <summary>
  238. Target member type
  239. </summary>
  240. </member>
  241. <member name="P:Dapper.SqlMapper.IMemberMap.Property">
  242. <summary>
  243. Target property
  244. </summary>
  245. </member>
  246. <member name="P:Dapper.SqlMapper.IMemberMap.Field">
  247. <summary>
  248. Target field
  249. </summary>
  250. </member>
  251. <member name="P:Dapper.SqlMapper.IMemberMap.Parameter">
  252. <summary>
  253. Target constructor parameter
  254. </summary>
  255. </member>
  256. <member name="T:Dapper.SqlMapper.Link`2">
  257. <summary>
  258. This is a micro-cache; suitable when the number of terms is controllable (a few hundred, for example),
  259. and strictly append-only; you cannot change existing values. All key matches are on **REFERENCE**
  260. equality. The type is fully thread-safe.
  261. </summary>
  262. </member>
  263. <member name="E:Dapper.SqlMapper.QueryCachePurged">
  264. <summary>
  265. Called if the query cache is purged via PurgeQueryCache
  266. </summary>
  267. </member>
  268. <member name="M:Dapper.SqlMapper.PurgeQueryCache">
  269. <summary>
  270. Purge the query cache
  271. </summary>
  272. </member>
  273. <member name="M:Dapper.SqlMapper.GetCachedSQLCount">
  274. <summary>
  275. Return a count of all the cached queries by dapper
  276. </summary>
  277. <returns></returns>
  278. </member>
  279. <member name="M:Dapper.SqlMapper.GetCachedSQL(System.Int32)">
  280. <summary>
  281. Return a list of all the queries cached by dapper
  282. </summary>
  283. <param name="ignoreHitCountAbove"></param>
  284. <returns></returns>
  285. </member>
  286. <member name="M:Dapper.SqlMapper.GetHashCollissions">
  287. <summary>
  288. Deep diagnostics only: find any hash collisions in the cache
  289. </summary>
  290. <returns></returns>
  291. </member>
  292. <member name="M:Dapper.SqlMapper.ResetTypeHandlers">
  293. <summary>
  294. Clear the registered type handlers
  295. </summary>
  296. </member>
  297. <member name="M:Dapper.SqlMapper.AddTypeMap(System.Type,System.Data.DbType)">
  298. <summary>
  299. Configure the specified type to be mapped to a given db-type
  300. </summary>
  301. </member>
  302. <member name="M:Dapper.SqlMapper.AddTypeHandler(System.Type,Dapper.SqlMapper.ITypeHandler)">
  303. <summary>
  304. Configure the specified type to be processed by a custom handler
  305. </summary>
  306. </member>
  307. <member name="M:Dapper.SqlMapper.AddTypeHandlerImpl(System.Type,Dapper.SqlMapper.ITypeHandler,System.Boolean)">
  308. <summary>
  309. Configure the specified type to be processed by a custom handler
  310. </summary>
  311. </member>
  312. <member name="M:Dapper.SqlMapper.AddTypeHandler``1(Dapper.SqlMapper.TypeHandler{``0})">
  313. <summary>
  314. Configure the specified type to be processed by a custom handler
  315. </summary>
  316. </member>
  317. <member name="T:Dapper.SqlMapper.TypeHandlerCache`1">
  318. <summary>
  319. Not intended for direct usage
  320. </summary>
  321. </member>
  322. <member name="M:Dapper.SqlMapper.TypeHandlerCache`1.Parse(System.Object)">
  323. <summary>
  324. Not intended for direct usage
  325. </summary>
  326. </member>
  327. <member name="M:Dapper.SqlMapper.TypeHandlerCache`1.SetValue(System.Data.IDbDataParameter,System.Object)">
  328. <summary>
  329. Not intended for direct usage
  330. </summary>
  331. </member>
  332. <member name="M:Dapper.SqlMapper.GetDbType(System.Object)">
  333. <summary>
  334. Get the DbType that maps to a given value
  335. </summary>
  336. </member>
  337. <member name="T:Dapper.SqlMapper.Identity">
  338. <summary>
  339. Identity of a cached query in Dapper, used for extensibility
  340. </summary>
  341. </member>
  342. <member name="M:Dapper.SqlMapper.Identity.ForDynamicParameters(System.Type)">
  343. <summary>
  344. Create an identity for use with DynamicParameters, internal use only
  345. </summary>
  346. <param name="type"></param>
  347. <returns></returns>
  348. </member>
  349. <member name="M:Dapper.SqlMapper.Identity.Equals(System.Object)">
  350. <summary>
  351. </summary>
  352. <param name="obj"></param>
  353. <returns></returns>
  354. </member>
  355. <member name="F:Dapper.SqlMapper.Identity.sql">
  356. <summary>
  357. The sql
  358. </summary>
  359. </member>
  360. <member name="F:Dapper.SqlMapper.Identity.commandType">
  361. <summary>
  362. The command type
  363. </summary>
  364. </member>
  365. <member name="F:Dapper.SqlMapper.Identity.hashCode">
  366. <summary>
  367. </summary>
  368. </member>
  369. <member name="F:Dapper.SqlMapper.Identity.gridIndex">
  370. <summary>
  371. </summary>
  372. </member>
  373. <member name="F:Dapper.SqlMapper.Identity.type">
  374. <summary>
  375. </summary>
  376. </member>
  377. <member name="F:Dapper.SqlMapper.Identity.connectionString">
  378. <summary>
  379. </summary>
  380. </member>
  381. <member name="F:Dapper.SqlMapper.Identity.parametersType">
  382. <summary>
  383. </summary>
  384. </member>
  385. <member name="M:Dapper.SqlMapper.Identity.GetHashCode">
  386. <summary>
  387. </summary>
  388. <returns></returns>
  389. </member>
  390. <member name="M:Dapper.SqlMapper.Identity.Equals(Dapper.SqlMapper.Identity)">
  391. <summary>
  392. Compare 2 Identity objects
  393. </summary>
  394. <param name="other"></param>
  395. <returns></returns>
  396. </member>
  397. <member name="M:Dapper.SqlMapper.AsList``1(System.Collections.Generic.IEnumerable{``0})">
  398. <summary>
  399. Obtains the data as a list; if it is *already* a list, the original object is returned without
  400. any duplication; otherwise, ToList() is invoked.
  401. </summary>
  402. </member>
  403. <member name="M:Dapper.SqlMapper.Execute(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  404. <summary>
  405. Execute parameterized SQL
  406. </summary>
  407. <returns>Number of rows affected</returns>
  408. </member>
  409. <member name="M:Dapper.SqlMapper.Execute(System.Data.IDbConnection,Dapper.CommandDefinition)">
  410. <summary>
  411. Execute parameterized SQL
  412. </summary>
  413. <returns>Number of rows affected</returns>
  414. </member>
  415. <member name="M:Dapper.SqlMapper.ExecuteScalar(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  416. <summary>
  417. Execute parameterized SQL that selects a single value
  418. </summary>
  419. <returns>The first cell selected</returns>
  420. </member>
  421. <member name="M:Dapper.SqlMapper.ExecuteScalar``1(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  422. <summary>
  423. Execute parameterized SQL that selects a single value
  424. </summary>
  425. <returns>The first cell selected</returns>
  426. </member>
  427. <member name="M:Dapper.SqlMapper.ExecuteScalar(System.Data.IDbConnection,Dapper.CommandDefinition)">
  428. <summary>
  429. Execute parameterized SQL that selects a single value
  430. </summary>
  431. <returns>The first cell selected</returns>
  432. </member>
  433. <member name="M:Dapper.SqlMapper.ExecuteScalar``1(System.Data.IDbConnection,Dapper.CommandDefinition)">
  434. <summary>
  435. Execute parameterized SQL that selects a single value
  436. </summary>
  437. <returns>The first cell selected</returns>
  438. </member>
  439. <member name="M:Dapper.SqlMapper.ExecuteReader(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  440. <summary>
  441. Execute parameterized SQL and return an <see cref="T:System.Data.IDataReader"/>
  442. </summary>
  443. <returns>An <see cref="T:System.Data.IDataReader"/> that can be used to iterate over the results of the SQL query.</returns>
  444. <remarks>
  445. This is typically used when the results of a query are not processed by Dapper, for example, used to fill a <see cref="T:System.Data.DataTable"/>
  446. or <see cref="T:System.Data.DataSet"/>.
  447. </remarks>
  448. <example>
  449. <code>
  450. <![CDATA[
  451. DataTable table = new DataTable("MyTable");
  452. using (var reader = ExecuteReader(cnn, sql, param))
  453. {
  454. table.Load(reader);
  455. }
  456. ]]>
  457. </code>
  458. </example>
  459. </member>
  460. <member name="M:Dapper.SqlMapper.ExecuteReader(System.Data.IDbConnection,Dapper.CommandDefinition)">
  461. <summary>
  462. Execute parameterized SQL and return an <see cref="T:System.Data.IDataReader"/>
  463. </summary>
  464. <returns>An <see cref="T:System.Data.IDataReader"/> that can be used to iterate over the results of the SQL query.</returns>
  465. <remarks>
  466. This is typically used when the results of a query are not processed by Dapper, for example, used to fill a <see cref="T:System.Data.DataTable"/>
  467. or <see cref="T:System.Data.DataSet"/>.
  468. </remarks>
  469. </member>
  470. <member name="M:Dapper.SqlMapper.ExecuteReader(System.Data.IDbConnection,Dapper.CommandDefinition,System.Data.CommandBehavior)">
  471. <summary>
  472. Execute parameterized SQL and return an <see cref="T:System.Data.IDataReader"/>
  473. </summary>
  474. <returns>An <see cref="T:System.Data.IDataReader"/> that can be used to iterate over the results of the SQL query.</returns>
  475. <remarks>
  476. This is typically used when the results of a query are not processed by Dapper, for example, used to fill a <see cref="T:System.Data.DataTable"/>
  477. or <see cref="T:System.Data.DataSet"/>.
  478. </remarks>
  479. </member>
  480. <member name="M:Dapper.SqlMapper.Query(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Boolean,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  481. <summary>
  482. Return a list of dynamic objects, reader is closed after the call
  483. </summary>
  484. <remarks>Note: each row can be accessed via "dynamic", or by casting to an IDictionary&lt;string,object&gt;</remarks>
  485. </member>
  486. <member name="M:Dapper.SqlMapper.Query``1(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Boolean,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  487. <summary>
  488. Executes a query, returning the data typed as per T
  489. </summary>
  490. <remarks>the dynamic param may seem a bit odd, but this works around a major usability issue in vs, if it is Object vs completion gets annoying. Eg type new [space] get new object</remarks>
  491. <returns>A sequence of data of the supplied type; if a basic type (int, string, etc) is queried then the data from the first column in assumed, otherwise an instance is
  492. created per row, and a direct column-name===member-name mapping is assumed (case insensitive).
  493. </returns>
  494. </member>
  495. <member name="M:Dapper.SqlMapper.Query(System.Data.IDbConnection,System.Type,System.String,System.Object,System.Data.IDbTransaction,System.Boolean,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  496. <summary>
  497. Executes a query, returning the data typed as per the Type suggested
  498. </summary>
  499. <returns>A sequence of data of the supplied type; if a basic type (int, string, etc) is queried then the data from the first column in assumed, otherwise an instance is
  500. created per row, and a direct column-name===member-name mapping is assumed (case insensitive).
  501. </returns>
  502. </member>
  503. <member name="M:Dapper.SqlMapper.Query``1(System.Data.IDbConnection,Dapper.CommandDefinition)">
  504. <summary>
  505. Executes a query, returning the data typed as per T
  506. </summary>
  507. <remarks>the dynamic param may seem a bit odd, but this works around a major usability issue in vs, if it is Object vs completion gets annoying. Eg type new [space] get new object</remarks>
  508. <returns>A sequence of data of the supplied type; if a basic type (int, string, etc) is queried then the data from the first column in assumed, otherwise an instance is
  509. created per row, and a direct column-name===member-name mapping is assumed (case insensitive).
  510. </returns>
  511. </member>
  512. <member name="M:Dapper.SqlMapper.QueryMultiple(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  513. <summary>
  514. Execute a command that returns multiple result sets, and access each in turn
  515. </summary>
  516. </member>
  517. <member name="M:Dapper.SqlMapper.QueryMultiple(System.Data.IDbConnection,Dapper.CommandDefinition)">
  518. <summary>
  519. Execute a command that returns multiple result sets, and access each in turn
  520. </summary>
  521. </member>
  522. <member name="M:Dapper.SqlMapper.Query``3(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  523. <summary>
  524. Maps a query to objects
  525. </summary>
  526. <typeparam name="TFirst">The first type in the record set</typeparam>
  527. <typeparam name="TSecond">The second type in the record set</typeparam>
  528. <typeparam name="TReturn">The return type</typeparam>
  529. <param name="cnn"></param>
  530. <param name="sql"></param>
  531. <param name="map"></param>
  532. <param name="param"></param>
  533. <param name="transaction"></param>
  534. <param name="buffered"></param>
  535. <param name="splitOn">The Field we should split and read the second object from (default: id)</param>
  536. <param name="commandTimeout">Number of seconds before command execution timeout</param>
  537. <param name="commandType">Is it a stored proc or a batch?</param>
  538. <returns></returns>
  539. </member>
  540. <member name="M:Dapper.SqlMapper.Query``4(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  541. <summary>
  542. Maps a query to objects
  543. </summary>
  544. <typeparam name="TFirst"></typeparam>
  545. <typeparam name="TSecond"></typeparam>
  546. <typeparam name="TThird"></typeparam>
  547. <typeparam name="TReturn"></typeparam>
  548. <param name="cnn"></param>
  549. <param name="sql"></param>
  550. <param name="map"></param>
  551. <param name="param"></param>
  552. <param name="transaction"></param>
  553. <param name="buffered"></param>
  554. <param name="splitOn">The Field we should split and read the second object from (default: id)</param>
  555. <param name="commandTimeout">Number of seconds before command execution timeout</param>
  556. <param name="commandType"></param>
  557. <returns></returns>
  558. </member>
  559. <member name="M:Dapper.SqlMapper.Query``5(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  560. <summary>
  561. Perform a multi mapping query with 4 input parameters
  562. </summary>
  563. <typeparam name="TFirst"></typeparam>
  564. <typeparam name="TSecond"></typeparam>
  565. <typeparam name="TThird"></typeparam>
  566. <typeparam name="TFourth"></typeparam>
  567. <typeparam name="TReturn"></typeparam>
  568. <param name="cnn"></param>
  569. <param name="sql"></param>
  570. <param name="map"></param>
  571. <param name="param"></param>
  572. <param name="transaction"></param>
  573. <param name="buffered"></param>
  574. <param name="splitOn"></param>
  575. <param name="commandTimeout"></param>
  576. <param name="commandType"></param>
  577. <returns></returns>
  578. </member>
  579. <member name="M:Dapper.SqlMapper.Query``6(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4,``5},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  580. <summary>
  581. Perform a multi mapping query with 5 input parameters
  582. </summary>
  583. <typeparam name="TFirst"></typeparam>
  584. <typeparam name="TSecond"></typeparam>
  585. <typeparam name="TThird"></typeparam>
  586. <typeparam name="TFourth"></typeparam>
  587. <typeparam name="TFifth"></typeparam>
  588. <typeparam name="TReturn"></typeparam>
  589. <param name="cnn"></param>
  590. <param name="sql"></param>
  591. <param name="map"></param>
  592. <param name="param"></param>
  593. <param name="transaction"></param>
  594. <param name="buffered"></param>
  595. <param name="splitOn"></param>
  596. <param name="commandTimeout"></param>
  597. <param name="commandType"></param>
  598. <returns></returns>
  599. </member>
  600. <member name="M:Dapper.SqlMapper.Query``7(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4,``5,``6},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  601. <summary>
  602. Perform a multi mapping query with 6 input parameters
  603. </summary>
  604. <typeparam name="TFirst"></typeparam>
  605. <typeparam name="TSecond"></typeparam>
  606. <typeparam name="TThird"></typeparam>
  607. <typeparam name="TFourth"></typeparam>
  608. <typeparam name="TFifth"></typeparam>
  609. <typeparam name="TSixth"></typeparam>
  610. <typeparam name="TReturn"></typeparam>
  611. <param name="cnn"></param>
  612. <param name="sql"></param>
  613. <param name="map"></param>
  614. <param name="param"></param>
  615. <param name="transaction"></param>
  616. <param name="buffered"></param>
  617. <param name="splitOn"></param>
  618. <param name="commandTimeout"></param>
  619. <param name="commandType"></param>
  620. <returns></returns>
  621. </member>
  622. <member name="M:Dapper.SqlMapper.Query``8(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4,``5,``6,``7},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  623. <summary>
  624. Perform a multi mapping query with 7 input parameters
  625. </summary>
  626. <typeparam name="TFirst"></typeparam>
  627. <typeparam name="TSecond"></typeparam>
  628. <typeparam name="TThird"></typeparam>
  629. <typeparam name="TFourth"></typeparam>
  630. <typeparam name="TFifth"></typeparam>
  631. <typeparam name="TSixth"></typeparam>
  632. <typeparam name="TSeventh"></typeparam>
  633. <typeparam name="TReturn"></typeparam>
  634. <param name="cnn"></param>
  635. <param name="sql"></param>
  636. <param name="map"></param>
  637. <param name="param"></param>
  638. <param name="transaction"></param>
  639. <param name="buffered"></param>
  640. <param name="splitOn"></param>
  641. <param name="commandTimeout"></param>
  642. <param name="commandType"></param>
  643. <returns></returns>
  644. </member>
  645. <member name="M:Dapper.SqlMapper.Query``1(System.Data.IDbConnection,System.String,System.Type[],System.Func{System.Object[],``0},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  646. <summary>
  647. Perform a multi mapping query with arbitrary input parameters
  648. </summary>
  649. <typeparam name="TReturn">The return type</typeparam>
  650. <param name="cnn"></param>
  651. <param name="sql"></param>
  652. <param name="types">array of types in the record set</param>
  653. <param name="map"></param>
  654. <param name="param"></param>
  655. <param name="transaction"></param>
  656. <param name="buffered"></param>
  657. <param name="splitOn">The Field we should split and read the second object from (default: id)</param>
  658. <param name="commandTimeout">Number of seconds before command execution timeout</param>
  659. <param name="commandType">Is it a stored proc or a batch?</param>
  660. <returns></returns>
  661. </member>
  662. <member name="M:Dapper.SqlMapper.ReadChar(System.Object)">
  663. <summary>
  664. Internal use only
  665. </summary>
  666. <param name="value"></param>
  667. <returns></returns>
  668. </member>
  669. <member name="M:Dapper.SqlMapper.ReadNullableChar(System.Object)">
  670. <summary>
  671. Internal use only
  672. </summary>
  673. </member>
  674. <member name="M:Dapper.SqlMapper.FindOrAddParameter(System.Data.IDataParameterCollection,System.Data.IDbCommand,System.String)">
  675. <summary>
  676. Internal use only
  677. </summary>
  678. </member>
  679. <member name="M:Dapper.SqlMapper.PackListParameters(System.Data.IDbCommand,System.String,System.Object)">
  680. <summary>
  681. Internal use only
  682. </summary>
  683. </member>
  684. <member name="T:Dapper.SqlMapper.LiteralToken">
  685. <summary>
  686. Represents a placeholder for a value that should be replaced as a literal value in the resulting sql
  687. </summary>
  688. </member>
  689. <member name="P:Dapper.SqlMapper.LiteralToken.Token">
  690. <summary>
  691. The text in the original command that should be replaced
  692. </summary>
  693. </member>
  694. <member name="P:Dapper.SqlMapper.LiteralToken.Member">
  695. <summary>
  696. The name of the member referred to by the token
  697. </summary>
  698. </member>
  699. <member name="M:Dapper.SqlMapper.ReplaceLiterals(Dapper.SqlMapper.IParameterLookup,System.Data.IDbCommand)">
  700. <summary>
  701. Replace all literal tokens with their text form
  702. </summary>
  703. </member>
  704. <member name="M:Dapper.SqlMapper.Format(System.Object)">
  705. <summary>
  706. Convert numeric values to their string form for SQL literal purposes
  707. </summary>
  708. </member>
  709. <member name="M:Dapper.SqlMapper.CreateParamInfoGenerator(Dapper.SqlMapper.Identity,System.Boolean,System.Boolean)">
  710. <summary>
  711. Internal use only
  712. </summary>
  713. </member>
  714. <member name="M:Dapper.SqlMapper.GetTypeMap(System.Type)">
  715. <summary>
  716. Gets type-map for the given type
  717. </summary>
  718. <returns>Type map implementation, DefaultTypeMap instance if no override present</returns>
  719. </member>
  720. <member name="M:Dapper.SqlMapper.SetTypeMap(System.Type,Dapper.SqlMapper.ITypeMap)">
  721. <summary>
  722. Set custom mapping for type deserializers
  723. </summary>
  724. <param name="type">Entity type to override</param>
  725. <param name="map">Mapping rules impementation, null to remove custom map</param>
  726. </member>
  727. <member name="M:Dapper.SqlMapper.GetTypeDeserializer(System.Type,System.Data.IDataReader,System.Int32,System.Int32,System.Boolean)">
  728. <summary>
  729. Internal use only
  730. </summary>
  731. <param name="type"></param>
  732. <param name="reader"></param>
  733. <param name="startBound"></param>
  734. <param name="length"></param>
  735. <param name="returnNullIfFirstMissing"></param>
  736. <returns></returns>
  737. </member>
  738. <member name="M:Dapper.SqlMapper.ThrowDataException(System.Exception,System.Int32,System.Data.IDataReader,System.Object)">
  739. <summary>
  740. Throws a data exception, only used internally
  741. </summary>
  742. </member>
  743. <member name="F:Dapper.SqlMapper.DataTableTypeNameKey">
  744. <summary>
  745. Key used to indicate the type name associated with a DataTable
  746. </summary>
  747. </member>
  748. <member name="P:Dapper.SqlMapper.ConnectionStringComparer">
  749. <summary>
  750. How should connection strings be compared for equivalence? Defaults to StringComparer.Ordinal.
  751. Providing a custom implementation can be useful for allowing multi-tenancy databases with identical
  752. schema to share strategies. Note that usual equivalence rules apply: any equivalent connection strings
  753. <b>MUST</b> yield the same hash-code.
  754. </summary>
  755. </member>
  756. <member name="T:Dapper.SqlMapper.GridReader">
  757. <summary>
  758. The grid reader provides interfaces for reading multiple result sets from a Dapper query
  759. </summary>
  760. </member>
  761. <member name="M:Dapper.SqlMapper.GridReader.Read(System.Boolean)">
  762. <summary>
  763. Read the next grid of results, returned as a dynamic object
  764. </summary>
  765. <remarks>Note: each row can be accessed via "dynamic", or by casting to an IDictionary&lt;string,object&gt;</remarks>
  766. </member>
  767. <member name="M:Dapper.SqlMapper.GridReader.Read``1(System.Boolean)">
  768. <summary>
  769. Read the next grid of results
  770. </summary>
  771. </member>
  772. <member name="M:Dapper.SqlMapper.GridReader.Read(System.Type,System.Boolean)">
  773. <summary>
  774. Read the next grid of results
  775. </summary>
  776. </member>
  777. <member name="M:Dapper.SqlMapper.GridReader.Read``3(System.Func{``0,``1,``2},System.String,System.Boolean)">
  778. <summary>
  779. Read multiple objects from a single record set on the grid
  780. </summary>
  781. </member>
  782. <member name="M:Dapper.SqlMapper.GridReader.Read``4(System.Func{``0,``1,``2,``3},System.String,System.Boolean)">
  783. <summary>
  784. Read multiple objects from a single record set on the grid
  785. </summary>
  786. </member>
  787. <member name="M:Dapper.SqlMapper.GridReader.Read``5(System.Func{``0,``1,``2,``3,``4},System.String,System.Boolean)">
  788. <summary>
  789. Read multiple objects from a single record set on the grid
  790. </summary>
  791. </member>
  792. <member name="M:Dapper.SqlMapper.GridReader.Read``6(System.Func{``0,``1,``2,``3,``4,``5},System.String,System.Boolean)">
  793. <summary>
  794. Read multiple objects from a single record set on the grid
  795. </summary>
  796. </member>
  797. <member name="M:Dapper.SqlMapper.GridReader.Read``7(System.Func{``0,``1,``2,``3,``4,``5,``6},System.String,System.Boolean)">
  798. <summary>
  799. Read multiple objects from a single record set on the grid
  800. </summary>
  801. </member>
  802. <member name="M:Dapper.SqlMapper.GridReader.Read``8(System.Func{``0,``1,``2,``3,``4,``5,``6,``7},System.String,System.Boolean)">
  803. <summary>
  804. Read multiple objects from a single record set on the grid
  805. </summary>
  806. </member>
  807. <member name="P:Dapper.SqlMapper.GridReader.IsConsumed">
  808. <summary>
  809. Has the underlying reader been consumed?
  810. </summary>
  811. </member>
  812. <member name="M:Dapper.SqlMapper.GridReader.Dispose">
  813. <summary>
  814. Dispose the grid, closing and disposing both the underlying reader and command.
  815. </summary>
  816. </member>
  817. <member name="M:Dapper.SqlMapper.GridReader.ReadAsync(System.Boolean)">
  818. <summary>
  819. Read the next grid of results, returned as a dynamic object
  820. </summary>
  821. <remarks>Note: each row can be accessed via "dynamic", or by casting to an IDictionary&lt;string,object&gt;</remarks>
  822. </member>
  823. <member name="M:Dapper.SqlMapper.GridReader.ReadAsync(System.Type,System.Boolean)">
  824. <summary>
  825. Read the next grid of results
  826. </summary>
  827. </member>
  828. <member name="M:Dapper.SqlMapper.GridReader.ReadAsync``1(System.Boolean)">
  829. <summary>
  830. Read the next grid of results
  831. </summary>
  832. </member>
  833. <member name="M:Dapper.SqlMapper.AsTableValuedParameter(System.Data.DataTable,System.String)">
  834. <summary>
  835. Used to pass a DataTable as a TableValuedParameter
  836. </summary>
  837. </member>
  838. <member name="M:Dapper.SqlMapper.SetTypeName(System.Data.DataTable,System.String)">
  839. <summary>
  840. Associate a DataTable with a type name
  841. </summary>
  842. </member>
  843. <member name="M:Dapper.SqlMapper.GetTypeName(System.Data.DataTable)">
  844. <summary>
  845. Fetch the type name associated with a DataTable
  846. </summary>
  847. </member>
  848. <member name="M:Dapper.SqlMapper.QueryAsync(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  849. <summary>
  850. Execute a query asynchronously using .NET 4.5 Task.
  851. </summary>
  852. <remarks>Note: each row can be accessed via "dynamic", or by casting to an IDictionary&lt;string,object&gt;</remarks>
  853. </member>
  854. <member name="M:Dapper.SqlMapper.QueryAsync(System.Data.IDbConnection,Dapper.CommandDefinition)">
  855. <summary>
  856. Execute a query asynchronously using .NET 4.5 Task.
  857. </summary>
  858. <remarks>Note: each row can be accessed via "dynamic", or by casting to an IDictionary&lt;string,object&gt;</remarks>
  859. </member>
  860. <member name="M:Dapper.SqlMapper.QueryAsync``1(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  861. <summary>
  862. Execute a query asynchronously using .NET 4.5 Task.
  863. </summary>
  864. </member>
  865. <member name="M:Dapper.SqlMapper.QueryAsync(System.Data.IDbConnection,System.Type,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  866. <summary>
  867. Execute a query asynchronously using .NET 4.5 Task.
  868. </summary>
  869. </member>
  870. <member name="M:Dapper.SqlMapper.QueryAsync``1(System.Data.IDbConnection,Dapper.CommandDefinition)">
  871. <summary>
  872. Execute a query asynchronously using .NET 4.5 Task.
  873. </summary>
  874. </member>
  875. <member name="M:Dapper.SqlMapper.QueryAsync(System.Data.IDbConnection,System.Type,Dapper.CommandDefinition)">
  876. <summary>
  877. Execute a query asynchronously using .NET 4.5 Task.
  878. </summary>
  879. </member>
  880. <member name="M:Dapper.SqlMapper.ExecuteAsync(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  881. <summary>
  882. Execute a command asynchronously using .NET 4.5 Task.
  883. </summary>
  884. </member>
  885. <member name="M:Dapper.SqlMapper.ExecuteAsync(System.Data.IDbConnection,Dapper.CommandDefinition)">
  886. <summary>
  887. Execute a command asynchronously using .NET 4.5 Task.
  888. </summary>
  889. </member>
  890. <member name="M:Dapper.SqlMapper.QueryAsync``3(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  891. <summary>
  892. Maps a query to objects
  893. </summary>
  894. <typeparam name="TFirst">The first type in the recordset</typeparam>
  895. <typeparam name="TSecond">The second type in the recordset</typeparam>
  896. <typeparam name="TReturn">The return type</typeparam>
  897. <param name="cnn"></param>
  898. <param name="sql"></param>
  899. <param name="map"></param>
  900. <param name="param"></param>
  901. <param name="transaction"></param>
  902. <param name="buffered"></param>
  903. <param name="splitOn">The field we should split and read the second object from (default: id)</param>
  904. <param name="commandTimeout">Number of seconds before command execution timeout</param>
  905. <param name="commandType">Is it a stored proc or a batch?</param>
  906. <returns></returns>
  907. </member>
  908. <member name="M:Dapper.SqlMapper.QueryAsync``3(System.Data.IDbConnection,Dapper.CommandDefinition,System.Func{``0,``1,``2},System.String)">
  909. <summary>
  910. Maps a query to objects
  911. </summary>
  912. <typeparam name="TFirst">The first type in the recordset</typeparam>
  913. <typeparam name="TSecond">The second type in the recordset</typeparam>
  914. <typeparam name="TReturn">The return type</typeparam>
  915. <param name="cnn"></param>
  916. <param name="splitOn">The field we should split and read the second object from (default: id)</param>
  917. <param name="command">The command to execute</param>
  918. <param name="map"></param>
  919. <returns></returns>
  920. </member>
  921. <member name="M:Dapper.SqlMapper.QueryAsync``4(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  922. <summary>
  923. Maps a query to objects
  924. </summary>
  925. <typeparam name="TFirst"></typeparam>
  926. <typeparam name="TSecond"></typeparam>
  927. <typeparam name="TThird"></typeparam>
  928. <typeparam name="TReturn"></typeparam>
  929. <param name="cnn"></param>
  930. <param name="sql"></param>
  931. <param name="map"></param>
  932. <param name="param"></param>
  933. <param name="transaction"></param>
  934. <param name="buffered"></param>
  935. <param name="splitOn">The Field we should split and read the second object from (default: id)</param>
  936. <param name="commandTimeout">Number of seconds before command execution timeout</param>
  937. <param name="commandType"></param>
  938. <returns></returns>
  939. </member>
  940. <member name="M:Dapper.SqlMapper.QueryAsync``4(System.Data.IDbConnection,Dapper.CommandDefinition,System.Func{``0,``1,``2,``3},System.String)">
  941. <summary>
  942. Maps a query to objects
  943. </summary>
  944. <typeparam name="TFirst"></typeparam>
  945. <typeparam name="TSecond"></typeparam>
  946. <typeparam name="TThird"></typeparam>
  947. <typeparam name="TReturn"></typeparam>
  948. <param name="cnn"></param>
  949. <param name="splitOn">The field we should split and read the second object from (default: id)</param>
  950. <param name="command">The command to execute</param>
  951. <param name="map"></param>
  952. <returns></returns>
  953. </member>
  954. <member name="M:Dapper.SqlMapper.QueryAsync``5(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  955. <summary>
  956. Perform a multi mapping query with 4 input parameters
  957. </summary>
  958. <typeparam name="TFirst"></typeparam>
  959. <typeparam name="TSecond"></typeparam>
  960. <typeparam name="TThird"></typeparam>
  961. <typeparam name="TFourth"></typeparam>
  962. <typeparam name="TReturn"></typeparam>
  963. <param name="cnn"></param>
  964. <param name="sql"></param>
  965. <param name="map"></param>
  966. <param name="param"></param>
  967. <param name="transaction"></param>
  968. <param name="buffered"></param>
  969. <param name="splitOn"></param>
  970. <param name="commandTimeout"></param>
  971. <param name="commandType"></param>
  972. <returns></returns>
  973. </member>
  974. <member name="M:Dapper.SqlMapper.QueryAsync``5(System.Data.IDbConnection,Dapper.CommandDefinition,System.Func{``0,``1,``2,``3,``4},System.String)">
  975. <summary>
  976. Perform a multi mapping query with 4 input parameters
  977. </summary>
  978. <typeparam name="TFirst"></typeparam>
  979. <typeparam name="TSecond"></typeparam>
  980. <typeparam name="TThird"></typeparam>
  981. <typeparam name="TFourth"></typeparam>
  982. <typeparam name="TReturn"></typeparam>
  983. <param name="cnn"></param>
  984. <param name="splitOn">The field we should split and read the second object from (default: id)</param>
  985. <param name="command">The command to execute</param>
  986. <param name="map"></param>
  987. <returns></returns>
  988. </member>
  989. <member name="M:Dapper.SqlMapper.QueryAsync``6(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4,``5},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  990. <summary>
  991. Perform a multi mapping query with 5 input parameters
  992. </summary>
  993. </member>
  994. <member name="M:Dapper.SqlMapper.QueryAsync``6(System.Data.IDbConnection,Dapper.CommandDefinition,System.Func{``0,``1,``2,``3,``4,``5},System.String)">
  995. <summary>
  996. Perform a multi mapping query with 5 input parameters
  997. </summary>
  998. </member>
  999. <member name="M:Dapper.SqlMapper.QueryAsync``7(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4,``5,``6},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1000. <summary>
  1001. Perform a multi mapping query with 6 input parameters
  1002. </summary>
  1003. </member>
  1004. <member name="M:Dapper.SqlMapper.QueryAsync``7(System.Data.IDbConnection,Dapper.CommandDefinition,System.Func{``0,``1,``2,``3,``4,``5,``6},System.String)">
  1005. <summary>
  1006. Perform a multi mapping query with 6 input parameters
  1007. </summary>
  1008. </member>
  1009. <member name="M:Dapper.SqlMapper.QueryAsync``8(System.Data.IDbConnection,System.String,System.Func{``0,``1,``2,``3,``4,``5,``6,``7},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1010. <summary>
  1011. Perform a multi mapping query with 7 input parameters
  1012. </summary>
  1013. </member>
  1014. <member name="M:Dapper.SqlMapper.QueryAsync``8(System.Data.IDbConnection,Dapper.CommandDefinition,System.Func{``0,``1,``2,``3,``4,``5,``6,``7},System.String)">
  1015. <summary>
  1016. Perform a multi mapping query with 7 input parameters
  1017. </summary>
  1018. </member>
  1019. <member name="M:Dapper.SqlMapper.QueryAsync``1(System.Data.IDbConnection,System.String,System.Type[],System.Func{System.Object[],``0},System.Object,System.Data.IDbTransaction,System.Boolean,System.String,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1020. <summary>
  1021. Perform a multi mapping query with arbitrary input parameters
  1022. </summary>
  1023. <typeparam name="TReturn">The return type</typeparam>
  1024. <param name="cnn"></param>
  1025. <param name="sql"></param>
  1026. <param name="types">array of types in the recordset</param>
  1027. <param name="map"></param>
  1028. <param name="param"></param>
  1029. <param name="transaction"></param>
  1030. <param name="buffered"></param>
  1031. <param name="splitOn">The Field we should split and read the second object from (default: id)</param>
  1032. <param name="commandTimeout">Number of seconds before command execution timeout</param>
  1033. <param name="commandType">Is it a stored proc or a batch?</param>
  1034. <returns></returns>
  1035. </member>
  1036. <member name="M:Dapper.SqlMapper.QueryMultipleAsync(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1037. <summary>
  1038. Execute a command that returns multiple result sets, and access each in turn
  1039. </summary>
  1040. </member>
  1041. <member name="M:Dapper.SqlMapper.QueryMultipleAsync(System.Data.IDbConnection,Dapper.CommandDefinition)">
  1042. <summary>
  1043. Execute a command that returns multiple result sets, and access each in turn
  1044. </summary>
  1045. </member>
  1046. <member name="M:Dapper.SqlMapper.ExecuteReaderAsync(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1047. <summary>
  1048. Execute parameterized SQL and return an <see cref="T:System.Data.IDataReader"/>
  1049. </summary>
  1050. <returns>An <see cref="T:System.Data.IDataReader"/> that can be used to iterate over the results of the SQL query.</returns>
  1051. <remarks>
  1052. This is typically used when the results of a query are not processed by Dapper, for example, used to fill a <see cref="T:System.Data.DataTable"/>
  1053. or <see cref="T:System.Data.DataSet"/>.
  1054. </remarks>
  1055. <example>
  1056. <code>
  1057. <![CDATA[
  1058. DataTable table = new DataTable("MyTable");
  1059. using (var reader = ExecuteReader(cnn, sql, param))
  1060. {
  1061. table.Load(reader);
  1062. }
  1063. ]]>
  1064. </code>
  1065. </example>
  1066. </member>
  1067. <member name="M:Dapper.SqlMapper.ExecuteReaderAsync(System.Data.IDbConnection,Dapper.CommandDefinition)">
  1068. <summary>
  1069. Execute parameterized SQL and return an <see cref="T:System.Data.IDataReader"/>
  1070. </summary>
  1071. <returns>An <see cref="T:System.Data.IDataReader"/> that can be used to iterate over the results of the SQL query.</returns>
  1072. <remarks>
  1073. This is typically used when the results of a query are not processed by Dapper, for example, used to fill a <see cref="T:System.Data.DataTable"/>
  1074. or <see cref="T:System.Data.DataSet"/>.
  1075. </remarks>
  1076. </member>
  1077. <member name="M:Dapper.SqlMapper.ExecuteScalarAsync(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1078. <summary>
  1079. Execute parameterized SQL that selects a single value
  1080. </summary>
  1081. <returns>The first cell selected</returns>
  1082. </member>
  1083. <member name="M:Dapper.SqlMapper.ExecuteScalarAsync``1(System.Data.IDbConnection,System.String,System.Object,System.Data.IDbTransaction,System.Nullable{System.Int32},System.Nullable{System.Data.CommandType})">
  1084. <summary>
  1085. Execute parameterized SQL that selects a single value
  1086. </summary>
  1087. <returns>The first cell selected</returns>
  1088. </member>
  1089. <member name="M:Dapper.SqlMapper.ExecuteScalarAsync(System.Data.IDbConnection,Dapper.CommandDefinition)">
  1090. <summary>
  1091. Execute parameterized SQL that selects a single value
  1092. </summary>
  1093. <returns>The first cell selected</returns>
  1094. </member>
  1095. <member name="M:Dapper.SqlMapper.ExecuteScalarAsync``1(System.Data.IDbConnection,Dapper.CommandDefinition)">
  1096. <summary>
  1097. Execute parameterized SQL that selects a single value
  1098. </summary>
  1099. <returns>The first cell selected</returns>
  1100. </member>
  1101. <member name="T:Dapper.DynamicParameters">
  1102. <summary>
  1103. A bag of parameters that can be passed to the Dapper Query and Execute methods
  1104. </summary>
  1105. </member>
  1106. <member name="M:Dapper.DynamicParameters.#ctor">
  1107. <summary>
  1108. construct a dynamic parameter bag
  1109. </summary>
  1110. </member>
  1111. <member name="M:Dapper.DynamicParameters.#ctor(System.Object)">
  1112. <summary>
  1113. construct a dynamic parameter bag
  1114. </summary>
  1115. <param name="template">can be an anonymous type or a DynamicParameters bag</param>
  1116. </member>
  1117. <member name="M:Dapper.DynamicParameters.AddDynamicParams(System.Object)">
  1118. <summary>
  1119. Append a whole object full of params to the dynamic
  1120. EG: AddDynamicParams(new {A = 1, B = 2}) // will add property A and B to the dynamic
  1121. </summary>
  1122. <param name="param"></param>
  1123. </member>
  1124. <member name="M:Dapper.DynamicParameters.Add(System.String,System.Object,System.Nullable{System.Data.DbType},System.Nullable{System.Data.ParameterDirection},System.Nullable{System.Int32})">
  1125. <summary>
  1126. Add a parameter to this dynamic parameter list
  1127. </summary>
  1128. </member>
  1129. <member name="M:Dapper.DynamicParameters.Add(System.String,System.Object,System.Nullable{System.Data.DbType},System.Nullable{System.Data.ParameterDirection},System.Nullable{System.Int32},System.Nullable{System.Byte},System.Nullable{System.Byte})">
  1130. <summary>
  1131. Add a parameter to this dynamic parameter list
  1132. </summary>
  1133. </member>
  1134. <member name="P:Dapper.DynamicParameters.RemoveUnused">
  1135. <summary>
  1136. If true, the command-text is inspected and only values that are clearly used are included on the connection
  1137. </summary>
  1138. </member>
  1139. <member name="M:Dapper.DynamicParameters.AddParameters(System.Data.IDbCommand,Dapper.SqlMapper.Identity)">
  1140. <summary>
  1141. Add all the parameters needed to the command just before it executes
  1142. </summary>
  1143. <param name="command">The raw command prior to execution</param>
  1144. <param name="identity">Information about the query</param>
  1145. </member>
  1146. <member name="P:Dapper.DynamicParameters.ParameterNames">
  1147. <summary>
  1148. All the names of the param in the bag, use Get to yank them out
  1149. </summary>
  1150. </member>
  1151. <member name="M:Dapper.DynamicParameters.Get``1(System.String)">
  1152. <summary>
  1153. Get the value of a parameter
  1154. </summary>
  1155. <typeparam name="T"></typeparam>
  1156. <param name="name"></param>
  1157. <returns>The value, note DBNull.Value is not returned, instead the value is returned as null</returns>
  1158. </member>
  1159. <member name="M:Dapper.DynamicParameters.Output``1(``0,System.Linq.Expressions.Expression{System.Func{``0,System.Object}},System.Nullable{System.Data.DbType},System.Nullable{System.Int32})">
  1160. <summary>
  1161. Allows you to automatically populate a target property/field from output parameters. It actually
  1162. creates an InputOutput parameter, so you can still pass data in.
  1163. </summary>
  1164. <typeparam name="T"></typeparam>
  1165. <param name="target">The object whose property/field you wish to populate.</param>
  1166. <param name="expression">A MemberExpression targeting a property/field of the target (or descendant thereof.)</param>
  1167. <param name="dbType"></param>
  1168. <param name="size">The size to set on the parameter. Defaults to 0, or DbString.DefaultLength in case of strings.</param>
  1169. <returns>The DynamicParameters instance</returns>
  1170. </member>
  1171. <member name="T:Dapper.TableValuedParameter">
  1172. <summary>
  1173. Used to pass a DataTable as a TableValuedParameter
  1174. </summary>
  1175. </member>
  1176. <member name="M:Dapper.TableValuedParameter.#ctor(System.Data.DataTable)">
  1177. <summary>
  1178. Create a new instance of TableValuedParameter
  1179. </summary>
  1180. </member>
  1181. <member name="M:Dapper.TableValuedParameter.#ctor(System.Data.DataTable,System.String)">
  1182. <summary>
  1183. Create a new instance of TableValuedParameter
  1184. </summary>
  1185. </member>
  1186. <member name="T:Dapper.DbString">
  1187. <summary>
  1188. This class represents a SQL string, it can be used if you need to denote your parameter is a Char vs VarChar vs nVarChar vs nChar
  1189. </summary>
  1190. </member>
  1191. <member name="F:Dapper.DbString.DefaultLength">
  1192. <summary>
  1193. A value to set the default value of strings
  1194. going through Dapper. Default is 4000, any value larger than this
  1195. field will not have the default value applied.
  1196. </summary>
  1197. </member>
  1198. <member name="M:Dapper.DbString.#ctor">
  1199. <summary>
  1200. Create a new DbString
  1201. </summary>
  1202. </member>
  1203. <member name="P:Dapper.DbString.IsAnsi">
  1204. <summary>
  1205. Ansi vs Unicode
  1206. </summary>
  1207. </member>
  1208. <member name="P:Dapper.DbString.IsFixedLength">
  1209. <summary>
  1210. Fixed length
  1211. </summary>
  1212. </member>
  1213. <member name="P:Dapper.DbString.Length">
  1214. <summary>
  1215. Length of the string -1 for max
  1216. </summary>
  1217. </member>
  1218. <member name="P:Dapper.DbString.Value">
  1219. <summary>
  1220. The value of the string
  1221. </summary>
  1222. </member>
  1223. <member name="M:Dapper.DbString.AddParameter(System.Data.IDbCommand,System.String)">
  1224. <summary>
  1225. Add the parameter to the command... internal use only
  1226. </summary>
  1227. <param name="command"></param>
  1228. <param name="name"></param>
  1229. </member>
  1230. <member name="T:Dapper.FeatureSupport">
  1231. <summary>
  1232. Handles variances in features per DBMS
  1233. </summary>
  1234. </member>
  1235. <member name="M:Dapper.FeatureSupport.Get(System.Data.IDbConnection)">
  1236. <summary>
  1237. Gets the feature set based on the passed connection
  1238. </summary>
  1239. </member>
  1240. <member name="P:Dapper.FeatureSupport.Arrays">
  1241. <summary>
  1242. True if the db supports array columns e.g. Postgresql
  1243. </summary>
  1244. </member>
  1245. <member name="T:Dapper.SimpleMemberMap">
  1246. <summary>
  1247. Represents simple member map for one of target parameter or property or field to source DataReader column
  1248. </summary>
  1249. </member>
  1250. <member name="M:Dapper.SimpleMemberMap.#ctor(System.String,System.Reflection.PropertyInfo)">
  1251. <summary>
  1252. Creates instance for simple property mapping
  1253. </summary>
  1254. <param name="columnName">DataReader column name</param>
  1255. <param name="property">Target property</param>
  1256. </member>
  1257. <member name="M:Dapper.SimpleMemberMap.#ctor(System.String,System.Reflection.FieldInfo)">
  1258. <summary>
  1259. Creates instance for simple field mapping
  1260. </summary>
  1261. <param name="columnName">DataReader column name</param>
  1262. <param name="field">Target property</param>
  1263. </member>
  1264. <member name="M:Dapper.SimpleMemberMap.#ctor(System.String,System.Reflection.ParameterInfo)">
  1265. <summary>
  1266. Creates instance for simple constructor parameter mapping
  1267. </summary>
  1268. <param name="columnName">DataReader column name</param>
  1269. <param name="parameter">Target constructor parameter</param>
  1270. </member>
  1271. <member name="P:Dapper.SimpleMemberMap.ColumnName">
  1272. <summary>
  1273. DataReader column name
  1274. </summary>
  1275. </member>
  1276. <member name="P:Dapper.SimpleMemberMap.MemberType">
  1277. <summary>
  1278. Target member type
  1279. </summary>
  1280. </member>
  1281. <member name="P:Dapper.SimpleMemberMap.Property">
  1282. <summary>
  1283. Target property
  1284. </summary>
  1285. </member>
  1286. <member name="P:Dapper.SimpleMemberMap.Field">
  1287. <summary>
  1288. Target field
  1289. </summary>
  1290. </member>
  1291. <member name="P:Dapper.SimpleMemberMap.Parameter">
  1292. <summary>
  1293. Target constructor parameter
  1294. </summary>
  1295. </member>
  1296. <member name="T:Dapper.DefaultTypeMap">
  1297. <summary>
  1298. Represents default type mapping strategy used by Dapper
  1299. </summary>
  1300. </member>
  1301. <member name="M:Dapper.DefaultTypeMap.#ctor(System.Type)">
  1302. <summary>
  1303. Creates default type map
  1304. </summary>
  1305. <param name="type">Entity type</param>
  1306. </member>
  1307. <member name="M:Dapper.DefaultTypeMap.FindConstructor(System.String[],System.Type[])">
  1308. <summary>
  1309. Finds best constructor
  1310. </summary>
  1311. <param name="names">DataReader column names</param>
  1312. <param name="types">DataReader column types</param>
  1313. <returns>Matching constructor or default one</returns>
  1314. </member>
  1315. <member name="M:Dapper.DefaultTypeMap.FindExplicitConstructor">
  1316. <summary>
  1317. Returns the constructor, if any, that has the ExplicitConstructorAttribute on it.
  1318. </summary>
  1319. </member>
  1320. <member name="M:Dapper.DefaultTypeMap.GetConstructorParameter(System.Reflection.ConstructorInfo,System.String)">
  1321. <summary>
  1322. Gets mapping for constructor parameter
  1323. </summary>
  1324. <param name="constructor">Constructor to resolve</param>
  1325. <param name="columnName">DataReader column name</param>
  1326. <returns>Mapping implementation</returns>
  1327. </member>
  1328. <member name="M:Dapper.DefaultTypeMap.GetMember(System.String)">
  1329. <summary>
  1330. Gets member mapping for column
  1331. </summary>
  1332. <param name="columnName">DataReader column name</param>
  1333. <returns>Mapping implementation</returns>
  1334. </member>
  1335. <member name="P:Dapper.DefaultTypeMap.MatchNamesWithUnderscores">
  1336. <summary>
  1337. Should column names like User_Id be allowed to match properties/fields like UserId ?
  1338. </summary>
  1339. </member>
  1340. <member name="T:Dapper.CustomPropertyTypeMap">
  1341. <summary>
  1342. Implements custom property mapping by user provided criteria (usually presence of some custom attribute with column to member mapping)
  1343. </summary>
  1344. </member>
  1345. <member name="M:Dapper.CustomPropertyTypeMap.#ctor(System.Type,System.Func{System.Type,System.String,System.Reflection.PropertyInfo})">
  1346. <summary>
  1347. Creates custom property mapping
  1348. </summary>
  1349. <param name="type">Target entity type</param>
  1350. <param name="propertySelector">Property selector based on target type and DataReader column name</param>
  1351. </member>
  1352. <member name="M:Dapper.CustomPropertyTypeMap.FindConstructor(System.String[],System.Type[])">
  1353. <summary>
  1354. Always returns default constructor
  1355. </summary>
  1356. <param name="names">DataReader column names</param>
  1357. <param name="types">DataReader column types</param>
  1358. <returns>Default constructor</returns>
  1359. </member>
  1360. <member name="M:Dapper.CustomPropertyTypeMap.FindExplicitConstructor">
  1361. <summary>
  1362. Always returns null
  1363. </summary>
  1364. <returns></returns>
  1365. </member>
  1366. <member name="M:Dapper.CustomPropertyTypeMap.GetConstructorParameter(System.Reflection.ConstructorInfo,System.String)">
  1367. <summary>
  1368. Not implemented as far as default constructor used for all cases
  1369. </summary>
  1370. <param name="constructor"></param>
  1371. <param name="columnName"></param>
  1372. <returns></returns>
  1373. </member>
  1374. <member name="M:Dapper.CustomPropertyTypeMap.GetMember(System.String)">
  1375. <summary>
  1376. Returns property based on selector strategy
  1377. </summary>
  1378. <param name="columnName">DataReader column name</param>
  1379. <returns>Poperty member map</returns>
  1380. </member>
  1381. <member name="T:Dapper.IWrappedDataReader">
  1382. <summary>
  1383. Describes a reader that controls the lifetime of both a command and a reader,
  1384. exposing the downstream command/reader as properties.
  1385. </summary>
  1386. </member>
  1387. <member name="P:Dapper.IWrappedDataReader.Reader">
  1388. <summary>
  1389. Obtain the underlying reader
  1390. </summary>
  1391. </member>
  1392. <member name="P:Dapper.IWrappedDataReader.Command">
  1393. <summary>
  1394. Obtain the underlying command
  1395. </summary>
  1396. </member>
  1397. <member name="T:Dapper.ExplicitConstructorAttribute">
  1398. <summary>
  1399. Tell Dapper to use an explicit constructor, passing nulls or 0s for all parameters
  1400. </summary>
  1401. </member>
  1402. </members>
  1403. </doc>