session.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886
  1. // Copyright (c) 2012 The gocql Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. package gocql
  5. import (
  6. "bytes"
  7. "encoding/binary"
  8. "errors"
  9. "fmt"
  10. "io"
  11. "strings"
  12. "sync"
  13. "time"
  14. "unicode"
  15. "github.com/golang/groupcache/lru"
  16. )
  17. // Session is the interface used by users to interact with the database.
  18. //
  19. // It's safe for concurrent use by multiple goroutines and a typical usage
  20. // scenario is to have one global session object to interact with the
  21. // whole Cassandra cluster.
  22. //
  23. // This type extends the Node interface by adding a convinient query builder
  24. // and automatically sets a default consinstency level on all operations
  25. // that do not have a consistency level set.
  26. type Session struct {
  27. Pool ConnectionPool
  28. cons Consistency
  29. pageSize int
  30. prefetch float64
  31. routingKeyInfoCache routingKeyInfoLRU
  32. schemaDescriber *schemaDescriber
  33. trace Tracer
  34. mu sync.RWMutex
  35. cfg ClusterConfig
  36. closeMu sync.RWMutex
  37. isClosed bool
  38. }
  39. // NewSession wraps an existing Node.
  40. func NewSession(p ConnectionPool, c ClusterConfig) *Session {
  41. session := &Session{Pool: p, cons: c.Consistency, prefetch: 0.25, cfg: c}
  42. // create the query info cache
  43. session.routingKeyInfoCache.lru = lru.New(c.MaxRoutingKeyInfo)
  44. return session
  45. }
  46. // SetConsistency sets the default consistency level for this session. This
  47. // setting can also be changed on a per-query basis and the default value
  48. // is Quorum.
  49. func (s *Session) SetConsistency(cons Consistency) {
  50. s.mu.Lock()
  51. s.cons = cons
  52. s.mu.Unlock()
  53. }
  54. // SetPageSize sets the default page size for this session. A value <= 0 will
  55. // disable paging. This setting can also be changed on a per-query basis.
  56. func (s *Session) SetPageSize(n int) {
  57. s.mu.Lock()
  58. s.pageSize = n
  59. s.mu.Unlock()
  60. }
  61. // SetPrefetch sets the default threshold for pre-fetching new pages. If
  62. // there are only p*pageSize rows remaining, the next page will be requested
  63. // automatically. This value can also be changed on a per-query basis and
  64. // the default value is 0.25.
  65. func (s *Session) SetPrefetch(p float64) {
  66. s.mu.Lock()
  67. s.prefetch = p
  68. s.mu.Unlock()
  69. }
  70. // SetTrace sets the default tracer for this session. This setting can also
  71. // be changed on a per-query basis.
  72. func (s *Session) SetTrace(trace Tracer) {
  73. s.mu.Lock()
  74. s.trace = trace
  75. s.mu.Unlock()
  76. }
  77. // Query generates a new query object for interacting with the database.
  78. // Further details of the query may be tweaked using the resulting query
  79. // value before the query is executed. Query is automatically prepared
  80. // if it has not previously been executed.
  81. func (s *Session) Query(stmt string, values ...interface{}) *Query {
  82. s.mu.RLock()
  83. qry := &Query{stmt: stmt, values: values, cons: s.cons,
  84. session: s, pageSize: s.pageSize, trace: s.trace,
  85. prefetch: s.prefetch, rt: s.cfg.RetryPolicy}
  86. s.mu.RUnlock()
  87. return qry
  88. }
  89. type QueryInfo struct {
  90. Id []byte
  91. Args []ColumnInfo
  92. Rval []ColumnInfo
  93. }
  94. // Bind generates a new query object based on the query statement passed in.
  95. // The query is automatically prepared if it has not previously been executed.
  96. // The binding callback allows the application to define which query argument
  97. // values will be marshalled as part of the query execution.
  98. // During execution, the meta data of the prepared query will be routed to the
  99. // binding callback, which is responsible for producing the query argument values.
  100. func (s *Session) Bind(stmt string, b func(q *QueryInfo) ([]interface{}, error)) *Query {
  101. s.mu.RLock()
  102. qry := &Query{stmt: stmt, binding: b, cons: s.cons,
  103. session: s, pageSize: s.pageSize, trace: s.trace,
  104. prefetch: s.prefetch, rt: s.cfg.RetryPolicy}
  105. s.mu.RUnlock()
  106. return qry
  107. }
  108. // Close closes all connections. The session is unusable after this
  109. // operation.
  110. func (s *Session) Close() {
  111. s.closeMu.Lock()
  112. defer s.closeMu.Unlock()
  113. if s.isClosed {
  114. return
  115. }
  116. s.isClosed = true
  117. s.Pool.Close()
  118. }
  119. func (s *Session) Closed() bool {
  120. s.closeMu.RLock()
  121. closed := s.isClosed
  122. s.closeMu.RUnlock()
  123. return closed
  124. }
  125. func (s *Session) executeQuery(qry *Query) *Iter {
  126. // fail fast
  127. if s.Closed() {
  128. return &Iter{err: ErrSessionClosed}
  129. }
  130. var iter *Iter
  131. qry.attempts = 0
  132. qry.totalLatency = 0
  133. for {
  134. conn := s.Pool.Pick(qry)
  135. //Assign the error unavailable to the iterator
  136. if conn == nil {
  137. iter = &Iter{err: ErrNoConnections}
  138. break
  139. }
  140. t := time.Now()
  141. iter = conn.executeQuery(qry)
  142. qry.totalLatency += time.Now().Sub(t).Nanoseconds()
  143. qry.attempts++
  144. //Exit for loop if the query was successful
  145. if iter.err == nil {
  146. break
  147. }
  148. if qry.rt == nil || !qry.rt.Attempt(qry) {
  149. break
  150. }
  151. }
  152. return iter
  153. }
  154. // KeyspaceMetadata returns the schema metadata for the keyspace specified.
  155. func (s *Session) KeyspaceMetadata(keyspace string) (*KeyspaceMetadata, error) {
  156. // fail fast
  157. if s.Closed() {
  158. return nil, ErrSessionClosed
  159. }
  160. if keyspace == "" {
  161. return nil, ErrNoKeyspace
  162. }
  163. s.mu.Lock()
  164. // lazy-init schemaDescriber
  165. if s.schemaDescriber == nil {
  166. s.schemaDescriber = newSchemaDescriber(s)
  167. }
  168. s.mu.Unlock()
  169. return s.schemaDescriber.getSchema(keyspace)
  170. }
  171. // returns routing key indexes and type info
  172. func (s *Session) routingKeyInfo(stmt string) (*routingKeyInfo, error) {
  173. s.routingKeyInfoCache.mu.Lock()
  174. cacheKey := s.cfg.Keyspace + stmt
  175. entry, cached := s.routingKeyInfoCache.lru.Get(cacheKey)
  176. if cached {
  177. // done accessing the cache
  178. s.routingKeyInfoCache.mu.Unlock()
  179. // the entry is an inflight struct similiar to that used by
  180. // Conn to prepare statements
  181. inflight := entry.(*inflightCachedEntry)
  182. // wait for any inflight work
  183. inflight.wg.Wait()
  184. if inflight.err != nil {
  185. return nil, inflight.err
  186. }
  187. return inflight.value.(*routingKeyInfo), nil
  188. }
  189. // create a new inflight entry while the data is created
  190. inflight := new(inflightCachedEntry)
  191. inflight.wg.Add(1)
  192. defer inflight.wg.Done()
  193. s.routingKeyInfoCache.lru.Add(cacheKey, inflight)
  194. s.routingKeyInfoCache.mu.Unlock()
  195. var (
  196. prepared *resultPreparedFrame
  197. partitionKey []*ColumnMetadata
  198. )
  199. // get the query info for the statement
  200. conn := s.Pool.Pick(nil)
  201. if conn == nil {
  202. // no connections
  203. inflight.err = ErrNoConnections
  204. // don't cache this error
  205. s.routingKeyInfoCache.Remove(cacheKey)
  206. return nil, inflight.err
  207. }
  208. prepared, inflight.err = conn.prepareStatement(stmt, nil)
  209. if inflight.err != nil {
  210. // don't cache this error
  211. s.routingKeyInfoCache.Remove(cacheKey)
  212. return nil, inflight.err
  213. }
  214. if len(prepared.reqMeta.columns) == 0 {
  215. // no arguments, no routing key, and no error
  216. return nil, nil
  217. }
  218. // get the table metadata
  219. table := prepared.reqMeta.columns[0].Table
  220. var keyspaceMetadata *KeyspaceMetadata
  221. keyspaceMetadata, inflight.err = s.KeyspaceMetadata(s.cfg.Keyspace)
  222. if inflight.err != nil {
  223. // don't cache this error
  224. s.routingKeyInfoCache.Remove(cacheKey)
  225. return nil, inflight.err
  226. }
  227. tableMetadata, found := keyspaceMetadata.Tables[table]
  228. if !found {
  229. // unlikely that the statement could be prepared and the metadata for
  230. // the table couldn't be found, but this may indicate either a bug
  231. // in the metadata code, or that the table was just dropped.
  232. inflight.err = ErrNoMetadata
  233. // don't cache this error
  234. s.routingKeyInfoCache.Remove(cacheKey)
  235. return nil, inflight.err
  236. }
  237. partitionKey = tableMetadata.PartitionKey
  238. size := len(partitionKey)
  239. routingKeyInfo := &routingKeyInfo{
  240. indexes: make([]int, size),
  241. types: make([]TypeInfo, size),
  242. }
  243. for keyIndex, keyColumn := range partitionKey {
  244. // set an indicator for checking if the mapping is missing
  245. routingKeyInfo.indexes[keyIndex] = -1
  246. // find the column in the query info
  247. for argIndex, boundColumn := range prepared.reqMeta.columns {
  248. if keyColumn.Name == boundColumn.Name {
  249. // there may be many such bound columns, pick the first
  250. routingKeyInfo.indexes[keyIndex] = argIndex
  251. routingKeyInfo.types[keyIndex] = boundColumn.TypeInfo
  252. break
  253. }
  254. }
  255. if routingKeyInfo.indexes[keyIndex] == -1 {
  256. // missing a routing key column mapping
  257. // no routing key, and no error
  258. return nil, nil
  259. }
  260. }
  261. // cache this result
  262. inflight.value = routingKeyInfo
  263. return routingKeyInfo, nil
  264. }
  265. // ExecuteBatch executes a batch operation and returns nil if successful
  266. // otherwise an error is returned describing the failure.
  267. func (s *Session) ExecuteBatch(batch *Batch) error {
  268. // fail fast
  269. if s.Closed() {
  270. return ErrSessionClosed
  271. }
  272. // Prevent the execution of the batch if greater than the limit
  273. // Currently batches have a limit of 65536 queries.
  274. // https://datastax-oss.atlassian.net/browse/JAVA-229
  275. if batch.Size() > BatchSizeMaximum {
  276. return ErrTooManyStmts
  277. }
  278. var err error
  279. batch.attempts = 0
  280. batch.totalLatency = 0
  281. for {
  282. conn := s.Pool.Pick(nil)
  283. //Assign the error unavailable and break loop
  284. if conn == nil {
  285. err = ErrNoConnections
  286. break
  287. }
  288. t := time.Now()
  289. err = conn.executeBatch(batch)
  290. batch.totalLatency += time.Now().Sub(t).Nanoseconds()
  291. batch.attempts++
  292. //Exit loop if operation executed correctly
  293. if err == nil {
  294. return nil
  295. }
  296. if batch.rt == nil || !batch.rt.Attempt(batch) {
  297. break
  298. }
  299. }
  300. return err
  301. }
  302. // Query represents a CQL statement that can be executed.
  303. type Query struct {
  304. stmt string
  305. values []interface{}
  306. cons Consistency
  307. pageSize int
  308. routingKey []byte
  309. pageState []byte
  310. prefetch float64
  311. trace Tracer
  312. session *Session
  313. rt RetryPolicy
  314. binding func(q *QueryInfo) ([]interface{}, error)
  315. attempts int
  316. totalLatency int64
  317. }
  318. //Attempts returns the number of times the query was executed.
  319. func (q *Query) Attempts() int {
  320. return q.attempts
  321. }
  322. //Latency returns the average amount of nanoseconds per attempt of the query.
  323. func (q *Query) Latency() int64 {
  324. if q.attempts > 0 {
  325. return q.totalLatency / int64(q.attempts)
  326. }
  327. return 0
  328. }
  329. // Consistency sets the consistency level for this query. If no consistency
  330. // level have been set, the default consistency level of the cluster
  331. // is used.
  332. func (q *Query) Consistency(c Consistency) *Query {
  333. q.cons = c
  334. return q
  335. }
  336. // GetConsistency returns the currently configured consistency level for
  337. // the query.
  338. func (q *Query) GetConsistency() Consistency {
  339. return q.cons
  340. }
  341. // Trace enables tracing of this query. Look at the documentation of the
  342. // Tracer interface to learn more about tracing.
  343. func (q *Query) Trace(trace Tracer) *Query {
  344. q.trace = trace
  345. return q
  346. }
  347. // PageSize will tell the iterator to fetch the result in pages of size n.
  348. // This is useful for iterating over large result sets, but setting the
  349. // page size to low might decrease the performance. This feature is only
  350. // available in Cassandra 2 and onwards.
  351. func (q *Query) PageSize(n int) *Query {
  352. q.pageSize = n
  353. return q
  354. }
  355. // RoutingKey sets the routing key to use when a token aware connection
  356. // pool is used to optimize the routing of this query.
  357. func (q *Query) RoutingKey(routingKey []byte) *Query {
  358. q.routingKey = routingKey
  359. return q
  360. }
  361. // GetRoutingKey gets the routing key to use for routing this query. If
  362. // a routing key has not been explicitly set, then the routing key will
  363. // be constructed if possible using the keyspace's schema and the query
  364. // info for this query statement. If the routing key cannot be determined
  365. // then nil will be returned with no error. On any error condition,
  366. // an error description will be returned.
  367. func (q *Query) GetRoutingKey() ([]byte, error) {
  368. if q.routingKey != nil {
  369. return q.routingKey, nil
  370. }
  371. // try to determine the routing key
  372. routingKeyInfo, err := q.session.routingKeyInfo(q.stmt)
  373. if err != nil {
  374. return nil, err
  375. }
  376. if routingKeyInfo == nil {
  377. return nil, nil
  378. }
  379. if len(routingKeyInfo.indexes) == 1 {
  380. // single column routing key
  381. routingKey, err := Marshal(
  382. routingKeyInfo.types[0],
  383. q.values[routingKeyInfo.indexes[0]],
  384. )
  385. if err != nil {
  386. return nil, err
  387. }
  388. return routingKey, nil
  389. }
  390. // composite routing key
  391. buf := &bytes.Buffer{}
  392. for i := range routingKeyInfo.indexes {
  393. encoded, err := Marshal(
  394. routingKeyInfo.types[i],
  395. q.values[routingKeyInfo.indexes[i]],
  396. )
  397. if err != nil {
  398. return nil, err
  399. }
  400. binary.Write(buf, binary.BigEndian, int16(len(encoded)))
  401. buf.Write(encoded)
  402. buf.WriteByte(0x00)
  403. }
  404. routingKey := buf.Bytes()
  405. return routingKey, nil
  406. }
  407. func (q *Query) shouldPrepare() bool {
  408. stmt := strings.TrimLeftFunc(strings.TrimRightFunc(q.stmt, func(r rune) bool {
  409. return unicode.IsSpace(r) || r == ';'
  410. }), unicode.IsSpace)
  411. var stmtType string
  412. if n := strings.IndexFunc(stmt, unicode.IsSpace); n >= 0 {
  413. stmtType = strings.ToLower(stmt[:n])
  414. }
  415. if stmtType == "begin" {
  416. if n := strings.LastIndexFunc(stmt, unicode.IsSpace); n >= 0 {
  417. stmtType = strings.ToLower(stmt[n+1:])
  418. }
  419. }
  420. switch stmtType {
  421. case "select", "insert", "update", "delete", "batch":
  422. return true
  423. }
  424. return false
  425. }
  426. // SetPrefetch sets the default threshold for pre-fetching new pages. If
  427. // there are only p*pageSize rows remaining, the next page will be requested
  428. // automatically.
  429. func (q *Query) Prefetch(p float64) *Query {
  430. q.prefetch = p
  431. return q
  432. }
  433. // RetryPolicy sets the policy to use when retrying the query.
  434. func (q *Query) RetryPolicy(r RetryPolicy) *Query {
  435. q.rt = r
  436. return q
  437. }
  438. // Bind sets query arguments of query. This can also be used to rebind new query arguments
  439. // to an existing query instance.
  440. func (q *Query) Bind(v ...interface{}) *Query {
  441. q.values = v
  442. return q
  443. }
  444. // Exec executes the query without returning any rows.
  445. func (q *Query) Exec() error {
  446. iter := q.Iter()
  447. return iter.err
  448. }
  449. // Iter executes the query and returns an iterator capable of iterating
  450. // over all results.
  451. func (q *Query) Iter() *Iter {
  452. if strings.Index(strings.ToLower(q.stmt), "use") == 0 {
  453. return &Iter{err: ErrUseStmt}
  454. }
  455. return q.session.executeQuery(q)
  456. }
  457. // MapScan executes the query, copies the columns of the first selected
  458. // row into the map pointed at by m and discards the rest. If no rows
  459. // were selected, ErrNotFound is returned.
  460. func (q *Query) MapScan(m map[string]interface{}) error {
  461. iter := q.Iter()
  462. if err := iter.checkErrAndNotFound(); err != nil {
  463. return err
  464. }
  465. iter.MapScan(m)
  466. return iter.Close()
  467. }
  468. // Scan executes the query, copies the columns of the first selected
  469. // row into the values pointed at by dest and discards the rest. If no rows
  470. // were selected, ErrNotFound is returned.
  471. func (q *Query) Scan(dest ...interface{}) error {
  472. iter := q.Iter()
  473. if err := iter.checkErrAndNotFound(); err != nil {
  474. return err
  475. }
  476. iter.Scan(dest...)
  477. return iter.Close()
  478. }
  479. // ScanCAS executes a lightweight transaction (i.e. an UPDATE or INSERT
  480. // statement containing an IF clause). If the transaction fails because
  481. // the existing values did not match, the previous values will be stored
  482. // in dest.
  483. func (q *Query) ScanCAS(dest ...interface{}) (applied bool, err error) {
  484. iter := q.Iter()
  485. if err := iter.checkErrAndNotFound(); err != nil {
  486. return false, err
  487. }
  488. if len(iter.Columns()) > 1 {
  489. dest = append([]interface{}{&applied}, dest...)
  490. iter.Scan(dest...)
  491. } else {
  492. iter.Scan(&applied)
  493. }
  494. return applied, iter.Close()
  495. }
  496. // MapScanCAS executes a lightweight transaction (i.e. an UPDATE or INSERT
  497. // statement containing an IF clause). If the transaction fails because
  498. // the existing values did not match, the previous values will be stored
  499. // in dest map.
  500. //
  501. // As for INSERT .. IF NOT EXISTS, previous values will be returned as if
  502. // SELECT * FROM. So using ScanCAS with INSERT is inherently prone to
  503. // column mismatching. MapScanCAS is added to capture them safely.
  504. func (q *Query) MapScanCAS(dest map[string]interface{}) (applied bool, err error) {
  505. iter := q.Iter()
  506. if err := iter.checkErrAndNotFound(); err != nil {
  507. return false, err
  508. }
  509. iter.MapScan(dest)
  510. applied = dest["[applied]"].(bool)
  511. delete(dest, "[applied]")
  512. return applied, iter.Close()
  513. }
  514. // Iter represents an iterator that can be used to iterate over all rows that
  515. // were returned by a query. The iterator might send additional queries to the
  516. // database during the iteration if paging was enabled.
  517. type Iter struct {
  518. err error
  519. pos int
  520. rows [][][]byte
  521. columns []ColumnInfo
  522. next *nextIter
  523. }
  524. // Columns returns the name and type of the selected columns.
  525. func (iter *Iter) Columns() []ColumnInfo {
  526. return iter.columns
  527. }
  528. // Scan consumes the next row of the iterator and copies the columns of the
  529. // current row into the values pointed at by dest. Use nil as a dest value
  530. // to skip the corresponding column. Scan might send additional queries
  531. // to the database to retrieve the next set of rows if paging was enabled.
  532. //
  533. // Scan returns true if the row was successfully unmarshaled or false if the
  534. // end of the result set was reached or if an error occurred. Close should
  535. // be called afterwards to retrieve any potential errors.
  536. func (iter *Iter) Scan(dest ...interface{}) bool {
  537. if iter.err != nil {
  538. return false
  539. }
  540. if iter.pos >= len(iter.rows) {
  541. if iter.next != nil {
  542. *iter = *iter.next.fetch()
  543. return iter.Scan(dest...)
  544. }
  545. return false
  546. }
  547. if iter.next != nil && iter.pos == iter.next.pos {
  548. go iter.next.fetch()
  549. }
  550. if len(dest) != len(iter.columns) {
  551. iter.err = errors.New("count mismatch")
  552. return false
  553. }
  554. for i := 0; i < len(iter.columns); i++ {
  555. if dest[i] == nil {
  556. continue
  557. }
  558. err := Unmarshal(iter.columns[i].TypeInfo, iter.rows[iter.pos][i], dest[i])
  559. if err != nil {
  560. iter.err = err
  561. return false
  562. }
  563. }
  564. iter.pos++
  565. return true
  566. }
  567. // Close closes the iterator and returns any errors that happened during
  568. // the query or the iteration.
  569. func (iter *Iter) Close() error {
  570. return iter.err
  571. }
  572. // checkErrAndNotFound handle error and NotFound in one method.
  573. func (iter *Iter) checkErrAndNotFound() error {
  574. if iter.err != nil {
  575. return iter.err
  576. } else if len(iter.rows) == 0 {
  577. return ErrNotFound
  578. }
  579. return nil
  580. }
  581. type nextIter struct {
  582. qry Query
  583. pos int
  584. once sync.Once
  585. next *Iter
  586. }
  587. func (n *nextIter) fetch() *Iter {
  588. n.once.Do(func() {
  589. n.next = n.qry.session.executeQuery(&n.qry)
  590. })
  591. return n.next
  592. }
  593. type Batch struct {
  594. Type BatchType
  595. Entries []BatchEntry
  596. Cons Consistency
  597. rt RetryPolicy
  598. attempts int
  599. totalLatency int64
  600. }
  601. // NewBatch creates a new batch operation without defaults from the cluster
  602. func NewBatch(typ BatchType) *Batch {
  603. return &Batch{Type: typ}
  604. }
  605. // NewBatch creates a new batch operation using defaults defined in the cluster
  606. func (s *Session) NewBatch(typ BatchType) *Batch {
  607. return &Batch{Type: typ, rt: s.cfg.RetryPolicy}
  608. }
  609. // Attempts returns the number of attempts made to execute the batch.
  610. func (b *Batch) Attempts() int {
  611. return b.attempts
  612. }
  613. //Latency returns the average number of nanoseconds to execute a single attempt of the batch.
  614. func (b *Batch) Latency() int64 {
  615. if b.attempts > 0 {
  616. return b.totalLatency / int64(b.attempts)
  617. }
  618. return 0
  619. }
  620. // GetConsistency returns the currently configured consistency level for the batch
  621. // operation.
  622. func (b *Batch) GetConsistency() Consistency {
  623. return b.Cons
  624. }
  625. // Query adds the query to the batch operation
  626. func (b *Batch) Query(stmt string, args ...interface{}) {
  627. b.Entries = append(b.Entries, BatchEntry{Stmt: stmt, Args: args})
  628. }
  629. // Bind adds the query to the batch operation and correlates it with a binding callback
  630. // that will be invoked when the batch is executed. The binding callback allows the application
  631. // to define which query argument values will be marshalled as part of the batch execution.
  632. func (b *Batch) Bind(stmt string, bind func(q *QueryInfo) ([]interface{}, error)) {
  633. b.Entries = append(b.Entries, BatchEntry{Stmt: stmt, binding: bind})
  634. }
  635. // RetryPolicy sets the retry policy to use when executing the batch operation
  636. func (b *Batch) RetryPolicy(r RetryPolicy) *Batch {
  637. b.rt = r
  638. return b
  639. }
  640. // Size returns the number of batch statements to be executed by the batch operation.
  641. func (b *Batch) Size() int {
  642. return len(b.Entries)
  643. }
  644. type BatchType byte
  645. const (
  646. LoggedBatch BatchType = 0
  647. UnloggedBatch = 1
  648. CounterBatch = 2
  649. )
  650. type BatchEntry struct {
  651. Stmt string
  652. Args []interface{}
  653. binding func(q *QueryInfo) ([]interface{}, error)
  654. }
  655. type ColumnInfo struct {
  656. Keyspace string
  657. Table string
  658. Name string
  659. TypeInfo TypeInfo
  660. }
  661. func (c ColumnInfo) String() string {
  662. return fmt.Sprintf("[column keyspace=%s table=%s name=%s type=%v]", c.Keyspace, c.Table, c.Name, c.TypeInfo)
  663. }
  664. // routing key indexes LRU cache
  665. type routingKeyInfoLRU struct {
  666. lru *lru.Cache
  667. mu sync.Mutex
  668. }
  669. type routingKeyInfo struct {
  670. indexes []int
  671. types []TypeInfo
  672. }
  673. func (r *routingKeyInfoLRU) Remove(key string) {
  674. r.mu.Lock()
  675. r.lru.Remove(key)
  676. r.mu.Unlock()
  677. }
  678. //Max adjusts the maximum size of the cache and cleans up the oldest records if
  679. //the new max is lower than the previous value. Not concurrency safe.
  680. func (r *routingKeyInfoLRU) Max(max int) {
  681. r.mu.Lock()
  682. for r.lru.Len() > max {
  683. r.lru.RemoveOldest()
  684. }
  685. r.lru.MaxEntries = max
  686. r.mu.Unlock()
  687. }
  688. type inflightCachedEntry struct {
  689. wg sync.WaitGroup
  690. err error
  691. value interface{}
  692. }
  693. // Tracer is the interface implemented by query tracers. Tracers have the
  694. // ability to obtain a detailed event log of all events that happened during
  695. // the execution of a query from Cassandra. Gathering this information might
  696. // be essential for debugging and optimizing queries, but this feature should
  697. // not be used on production systems with very high load.
  698. type Tracer interface {
  699. Trace(traceId []byte)
  700. }
  701. type traceWriter struct {
  702. session *Session
  703. w io.Writer
  704. mu sync.Mutex
  705. }
  706. // NewTraceWriter returns a simple Tracer implementation that outputs
  707. // the event log in a textual format.
  708. func NewTraceWriter(session *Session, w io.Writer) Tracer {
  709. return &traceWriter{session: session, w: w}
  710. }
  711. func (t *traceWriter) Trace(traceId []byte) {
  712. var (
  713. coordinator string
  714. duration int
  715. )
  716. t.session.Query(`SELECT coordinator, duration
  717. FROM system_traces.sessions
  718. WHERE session_id = ?`, traceId).
  719. Consistency(One).Scan(&coordinator, &duration)
  720. iter := t.session.Query(`SELECT event_id, activity, source, source_elapsed
  721. FROM system_traces.events
  722. WHERE session_id = ?`, traceId).
  723. Consistency(One).Iter()
  724. var (
  725. timestamp time.Time
  726. activity string
  727. source string
  728. elapsed int
  729. )
  730. t.mu.Lock()
  731. defer t.mu.Unlock()
  732. fmt.Fprintf(t.w, "Tracing session %016x (coordinator: %s, duration: %v):\n",
  733. traceId, coordinator, time.Duration(duration)*time.Microsecond)
  734. for iter.Scan(&timestamp, &activity, &source, &elapsed) {
  735. fmt.Fprintf(t.w, "%s: %s (source: %s, elapsed: %d)\n",
  736. timestamp.Format("2006/01/02 15:04:05.999999"), activity, source, elapsed)
  737. }
  738. if err := iter.Close(); err != nil {
  739. fmt.Fprintln(t.w, "Error:", err)
  740. }
  741. }
  742. type Error struct {
  743. Code int
  744. Message string
  745. }
  746. func (e Error) Error() string {
  747. return e.Message
  748. }
  749. var (
  750. ErrNotFound = errors.New("not found")
  751. ErrUnavailable = errors.New("unavailable")
  752. ErrUnsupported = errors.New("feature not supported")
  753. ErrTooManyStmts = errors.New("too many statements")
  754. ErrUseStmt = errors.New("use statements aren't supported. Please see https://github.com/gocql/gocql for explaination.")
  755. ErrSessionClosed = errors.New("session has been closed")
  756. ErrNoConnections = errors.New("no connections available")
  757. ErrNoKeyspace = errors.New("no keyspace provided")
  758. ErrNoMetadata = errors.New("no metadata available")
  759. )
  760. type ErrProtocol struct{ error }
  761. func NewErrProtocol(format string, args ...interface{}) error {
  762. return ErrProtocol{fmt.Errorf(format, args...)}
  763. }
  764. // BatchSizeMaximum is the maximum number of statements a batch operation can have.
  765. // This limit is set by cassandra and could change in the future.
  766. const BatchSizeMaximum = 65535