session.go 49 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787
  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. "context"
  8. "encoding/binary"
  9. "errors"
  10. "fmt"
  11. "io"
  12. "net"
  13. "strings"
  14. "sync"
  15. "sync/atomic"
  16. "time"
  17. "unicode"
  18. "github.com/gocql/gocql/internal/lru"
  19. )
  20. // Session is the interface used by users to interact with the database.
  21. //
  22. // It's safe for concurrent use by multiple goroutines and a typical usage
  23. // scenario is to have one global session object to interact with the
  24. // whole Cassandra cluster.
  25. //
  26. // This type extends the Node interface by adding a convinient query builder
  27. // and automatically sets a default consistency level on all operations
  28. // that do not have a consistency level set.
  29. type Session struct {
  30. cons Consistency
  31. pageSize int
  32. prefetch float64
  33. routingKeyInfoCache routingKeyInfoLRU
  34. schemaDescriber *schemaDescriber
  35. trace Tracer
  36. queryObserver QueryObserver
  37. batchObserver BatchObserver
  38. connectObserver ConnectObserver
  39. frameObserver FrameHeaderObserver
  40. hostSource *ringDescriber
  41. stmtsLRU *preparedLRU
  42. connCfg *ConnConfig
  43. executor *queryExecutor
  44. pool *policyConnPool
  45. policy HostSelectionPolicy
  46. ring ring
  47. metadata clusterMetadata
  48. mu sync.RWMutex
  49. control *controlConn
  50. // event handlers
  51. nodeEvents *eventDebouncer
  52. schemaEvents *eventDebouncer
  53. // ring metadata
  54. hosts []HostInfo
  55. useSystemSchema bool
  56. cfg ClusterConfig
  57. quit chan struct{}
  58. closeMu sync.RWMutex
  59. isClosed bool
  60. }
  61. var queryPool = &sync.Pool{
  62. New: func() interface{} {
  63. return new(Query)
  64. },
  65. }
  66. func addrsToHosts(addrs []string, defaultPort int) ([]*HostInfo, error) {
  67. var hosts []*HostInfo
  68. for _, hostport := range addrs {
  69. resolvedHosts, err := hostInfo(hostport, defaultPort)
  70. if err != nil {
  71. // Try other hosts if unable to resolve DNS name
  72. if _, ok := err.(*net.DNSError); ok {
  73. Logger.Printf("gocql: dns error: %v\n", err)
  74. continue
  75. }
  76. return nil, err
  77. }
  78. hosts = append(hosts, resolvedHosts...)
  79. }
  80. if len(hosts) == 0 {
  81. return nil, errors.New("failed to resolve any of the provided hostnames")
  82. }
  83. return hosts, nil
  84. }
  85. // NewSession wraps an existing Node.
  86. func NewSession(cfg ClusterConfig) (*Session, error) {
  87. // Check that hosts in the ClusterConfig is not empty
  88. if len(cfg.Hosts) < 1 {
  89. return nil, ErrNoHosts
  90. }
  91. s := &Session{
  92. cons: cfg.Consistency,
  93. prefetch: 0.25,
  94. cfg: cfg,
  95. pageSize: cfg.PageSize,
  96. stmtsLRU: &preparedLRU{lru: lru.New(cfg.MaxPreparedStmts)},
  97. quit: make(chan struct{}),
  98. connectObserver: cfg.ConnectObserver,
  99. }
  100. s.schemaDescriber = newSchemaDescriber(s)
  101. s.nodeEvents = newEventDebouncer("NodeEvents", s.handleNodeEvent)
  102. s.schemaEvents = newEventDebouncer("SchemaEvents", s.handleSchemaEvent)
  103. s.routingKeyInfoCache.lru = lru.New(cfg.MaxRoutingKeyInfo)
  104. s.hostSource = &ringDescriber{session: s}
  105. if cfg.PoolConfig.HostSelectionPolicy == nil {
  106. cfg.PoolConfig.HostSelectionPolicy = RoundRobinHostPolicy()
  107. }
  108. s.pool = cfg.PoolConfig.buildPool(s)
  109. s.policy = cfg.PoolConfig.HostSelectionPolicy
  110. s.policy.Init(s)
  111. s.executor = &queryExecutor{
  112. pool: s.pool,
  113. policy: cfg.PoolConfig.HostSelectionPolicy,
  114. }
  115. s.queryObserver = cfg.QueryObserver
  116. s.batchObserver = cfg.BatchObserver
  117. s.connectObserver = cfg.ConnectObserver
  118. s.frameObserver = cfg.FrameHeaderObserver
  119. //Check the TLS Config before trying to connect to anything external
  120. connCfg, err := connConfig(&s.cfg)
  121. if err != nil {
  122. //TODO: Return a typed error
  123. return nil, fmt.Errorf("gocql: unable to create session: %v", err)
  124. }
  125. s.connCfg = connCfg
  126. if err := s.init(); err != nil {
  127. s.Close()
  128. if err == ErrNoConnectionsStarted {
  129. //This error used to be generated inside NewSession & returned directly
  130. //Forward it on up to be backwards compatible
  131. return nil, ErrNoConnectionsStarted
  132. } else {
  133. // TODO(zariel): dont wrap this error in fmt.Errorf, return a typed error
  134. return nil, fmt.Errorf("gocql: unable to create session: %v", err)
  135. }
  136. }
  137. return s, nil
  138. }
  139. func (s *Session) init() error {
  140. hosts, err := addrsToHosts(s.cfg.Hosts, s.cfg.Port)
  141. if err != nil {
  142. return err
  143. }
  144. s.ring.endpoints = hosts
  145. if !s.cfg.disableControlConn {
  146. s.control = createControlConn(s)
  147. if s.cfg.ProtoVersion == 0 {
  148. proto, err := s.control.discoverProtocol(hosts)
  149. if err != nil {
  150. return fmt.Errorf("unable to discover protocol version: %v", err)
  151. } else if proto == 0 {
  152. return errors.New("unable to discovery protocol version")
  153. }
  154. // TODO(zariel): we really only need this in 1 place
  155. s.cfg.ProtoVersion = proto
  156. s.connCfg.ProtoVersion = proto
  157. }
  158. if err := s.control.connect(hosts); err != nil {
  159. return err
  160. }
  161. if !s.cfg.DisableInitialHostLookup {
  162. var partitioner string
  163. newHosts, partitioner, err := s.hostSource.GetHosts()
  164. if err != nil {
  165. return err
  166. }
  167. s.policy.SetPartitioner(partitioner)
  168. filteredHosts := make([]*HostInfo, 0, len(newHosts))
  169. for _, host := range newHosts {
  170. if !s.cfg.filterHost(host) {
  171. filteredHosts = append(filteredHosts, host)
  172. }
  173. }
  174. hosts = append(hosts, filteredHosts...)
  175. }
  176. }
  177. hostMap := make(map[string]*HostInfo, len(hosts))
  178. for _, host := range hosts {
  179. hostMap[host.ConnectAddress().String()] = host
  180. }
  181. for _, host := range hostMap {
  182. host = s.ring.addOrUpdate(host)
  183. s.addNewNode(host)
  184. }
  185. // TODO(zariel): we probably dont need this any more as we verify that we
  186. // can connect to one of the endpoints supplied by using the control conn.
  187. // See if there are any connections in the pool
  188. if s.cfg.ReconnectInterval > 0 {
  189. go s.reconnectDownedHosts(s.cfg.ReconnectInterval)
  190. }
  191. // If we disable the initial host lookup, we need to still check if the
  192. // cluster is using the newer system schema or not... however, if control
  193. // connection is disable, we really have no choice, so we just make our
  194. // best guess...
  195. if !s.cfg.disableControlConn && s.cfg.DisableInitialHostLookup {
  196. newer, _ := checkSystemSchema(s.control)
  197. s.useSystemSchema = newer
  198. } else {
  199. host := s.ring.rrHost()
  200. s.useSystemSchema = host.Version().Major >= 3
  201. }
  202. if s.pool.Size() == 0 {
  203. return ErrNoConnectionsStarted
  204. }
  205. return nil
  206. }
  207. func (s *Session) reconnectDownedHosts(intv time.Duration) {
  208. reconnectTicker := time.NewTicker(intv)
  209. defer reconnectTicker.Stop()
  210. for {
  211. select {
  212. case <-reconnectTicker.C:
  213. hosts := s.ring.allHosts()
  214. // Print session.ring for debug.
  215. if gocqlDebug {
  216. buf := bytes.NewBufferString("Session.ring:")
  217. for _, h := range hosts {
  218. buf.WriteString("[" + h.ConnectAddress().String() + ":" + h.State().String() + "]")
  219. }
  220. Logger.Println(buf.String())
  221. }
  222. for _, h := range hosts {
  223. if h.IsUp() {
  224. continue
  225. }
  226. s.handleNodeUp(h.ConnectAddress(), h.Port(), true)
  227. }
  228. case <-s.quit:
  229. return
  230. }
  231. }
  232. }
  233. // SetConsistency sets the default consistency level for this session. This
  234. // setting can also be changed on a per-query basis and the default value
  235. // is Quorum.
  236. func (s *Session) SetConsistency(cons Consistency) {
  237. s.mu.Lock()
  238. s.cons = cons
  239. s.mu.Unlock()
  240. }
  241. // SetPageSize sets the default page size for this session. A value <= 0 will
  242. // disable paging. This setting can also be changed on a per-query basis.
  243. func (s *Session) SetPageSize(n int) {
  244. s.mu.Lock()
  245. s.pageSize = n
  246. s.mu.Unlock()
  247. }
  248. // SetPrefetch sets the default threshold for pre-fetching new pages. If
  249. // there are only p*pageSize rows remaining, the next page will be requested
  250. // automatically. This value can also be changed on a per-query basis and
  251. // the default value is 0.25.
  252. func (s *Session) SetPrefetch(p float64) {
  253. s.mu.Lock()
  254. s.prefetch = p
  255. s.mu.Unlock()
  256. }
  257. // SetTrace sets the default tracer for this session. This setting can also
  258. // be changed on a per-query basis.
  259. func (s *Session) SetTrace(trace Tracer) {
  260. s.mu.Lock()
  261. s.trace = trace
  262. s.mu.Unlock()
  263. }
  264. // Query generates a new query object for interacting with the database.
  265. // Further details of the query may be tweaked using the resulting query
  266. // value before the query is executed. Query is automatically prepared
  267. // if it has not previously been executed.
  268. func (s *Session) Query(stmt string, values ...interface{}) *Query {
  269. qry := queryPool.Get().(*Query)
  270. qry.session = s
  271. qry.stmt = stmt
  272. qry.values = values
  273. qry.defaultsFromSession()
  274. return qry
  275. }
  276. type QueryInfo struct {
  277. Id []byte
  278. Args []ColumnInfo
  279. Rval []ColumnInfo
  280. PKeyColumns []int
  281. }
  282. // Bind generates a new query object based on the query statement passed in.
  283. // The query is automatically prepared if it has not previously been executed.
  284. // The binding callback allows the application to define which query argument
  285. // values will be marshalled as part of the query execution.
  286. // During execution, the meta data of the prepared query will be routed to the
  287. // binding callback, which is responsible for producing the query argument values.
  288. func (s *Session) Bind(stmt string, b func(q *QueryInfo) ([]interface{}, error)) *Query {
  289. qry := queryPool.Get().(*Query)
  290. qry.session = s
  291. qry.stmt = stmt
  292. qry.binding = b
  293. qry.defaultsFromSession()
  294. return qry
  295. }
  296. // Close closes all connections. The session is unusable after this
  297. // operation.
  298. func (s *Session) Close() {
  299. s.closeMu.Lock()
  300. defer s.closeMu.Unlock()
  301. if s.isClosed {
  302. return
  303. }
  304. s.isClosed = true
  305. if s.pool != nil {
  306. s.pool.Close()
  307. }
  308. if s.control != nil {
  309. s.control.close()
  310. }
  311. if s.nodeEvents != nil {
  312. s.nodeEvents.stop()
  313. }
  314. if s.schemaEvents != nil {
  315. s.schemaEvents.stop()
  316. }
  317. if s.quit != nil {
  318. close(s.quit)
  319. }
  320. }
  321. func (s *Session) Closed() bool {
  322. s.closeMu.RLock()
  323. closed := s.isClosed
  324. s.closeMu.RUnlock()
  325. return closed
  326. }
  327. func (s *Session) executeQuery(qry *Query) (it *Iter) {
  328. // fail fast
  329. if s.Closed() {
  330. return &Iter{err: ErrSessionClosed}
  331. }
  332. iter, err := s.executor.executeQuery(qry)
  333. if err != nil {
  334. return &Iter{err: err}
  335. }
  336. if iter == nil {
  337. panic("nil iter")
  338. }
  339. return iter
  340. }
  341. func (s *Session) removeHost(h *HostInfo) {
  342. s.policy.RemoveHost(h)
  343. s.pool.removeHost(h.ConnectAddress())
  344. s.ring.removeHost(h.ConnectAddress())
  345. }
  346. // KeyspaceMetadata returns the schema metadata for the keyspace specified. Returns an error if the keyspace does not exist.
  347. func (s *Session) KeyspaceMetadata(keyspace string) (*KeyspaceMetadata, error) {
  348. // fail fast
  349. if s.Closed() {
  350. return nil, ErrSessionClosed
  351. } else if keyspace == "" {
  352. return nil, ErrNoKeyspace
  353. }
  354. return s.schemaDescriber.getSchema(keyspace)
  355. }
  356. func (s *Session) getConn() *Conn {
  357. hosts := s.ring.allHosts()
  358. for _, host := range hosts {
  359. if !host.IsUp() {
  360. continue
  361. }
  362. pool, ok := s.pool.getPool(host)
  363. if !ok {
  364. continue
  365. } else if conn := pool.Pick(); conn != nil {
  366. return conn
  367. }
  368. }
  369. return nil
  370. }
  371. // returns routing key indexes and type info
  372. func (s *Session) routingKeyInfo(ctx context.Context, stmt string) (*routingKeyInfo, error) {
  373. s.routingKeyInfoCache.mu.Lock()
  374. entry, cached := s.routingKeyInfoCache.lru.Get(stmt)
  375. if cached {
  376. // done accessing the cache
  377. s.routingKeyInfoCache.mu.Unlock()
  378. // the entry is an inflight struct similar to that used by
  379. // Conn to prepare statements
  380. inflight := entry.(*inflightCachedEntry)
  381. // wait for any inflight work
  382. inflight.wg.Wait()
  383. if inflight.err != nil {
  384. return nil, inflight.err
  385. }
  386. key, _ := inflight.value.(*routingKeyInfo)
  387. return key, nil
  388. }
  389. // create a new inflight entry while the data is created
  390. inflight := new(inflightCachedEntry)
  391. inflight.wg.Add(1)
  392. defer inflight.wg.Done()
  393. s.routingKeyInfoCache.lru.Add(stmt, inflight)
  394. s.routingKeyInfoCache.mu.Unlock()
  395. var (
  396. info *preparedStatment
  397. partitionKey []*ColumnMetadata
  398. )
  399. conn := s.getConn()
  400. if conn == nil {
  401. // TODO: better error?
  402. inflight.err = errors.New("gocql: unable to fetch prepared info: no connection available")
  403. return nil, inflight.err
  404. }
  405. // get the query info for the statement
  406. info, inflight.err = conn.prepareStatement(ctx, stmt, nil)
  407. if inflight.err != nil {
  408. // don't cache this error
  409. s.routingKeyInfoCache.Remove(stmt)
  410. return nil, inflight.err
  411. }
  412. // TODO: it would be nice to mark hosts here but as we are not using the policies
  413. // to fetch hosts we cant
  414. if info.request.colCount == 0 {
  415. // no arguments, no routing key, and no error
  416. return nil, nil
  417. }
  418. if len(info.request.pkeyColumns) > 0 {
  419. // proto v4 dont need to calculate primary key columns
  420. types := make([]TypeInfo, len(info.request.pkeyColumns))
  421. for i, col := range info.request.pkeyColumns {
  422. types[i] = info.request.columns[col].TypeInfo
  423. }
  424. routingKeyInfo := &routingKeyInfo{
  425. indexes: info.request.pkeyColumns,
  426. types: types,
  427. }
  428. inflight.value = routingKeyInfo
  429. return routingKeyInfo, nil
  430. }
  431. // get the table metadata
  432. table := info.request.columns[0].Table
  433. var keyspaceMetadata *KeyspaceMetadata
  434. keyspaceMetadata, inflight.err = s.KeyspaceMetadata(info.request.columns[0].Keyspace)
  435. if inflight.err != nil {
  436. // don't cache this error
  437. s.routingKeyInfoCache.Remove(stmt)
  438. return nil, inflight.err
  439. }
  440. tableMetadata, found := keyspaceMetadata.Tables[table]
  441. if !found {
  442. // unlikely that the statement could be prepared and the metadata for
  443. // the table couldn't be found, but this may indicate either a bug
  444. // in the metadata code, or that the table was just dropped.
  445. inflight.err = ErrNoMetadata
  446. // don't cache this error
  447. s.routingKeyInfoCache.Remove(stmt)
  448. return nil, inflight.err
  449. }
  450. partitionKey = tableMetadata.PartitionKey
  451. size := len(partitionKey)
  452. routingKeyInfo := &routingKeyInfo{
  453. indexes: make([]int, size),
  454. types: make([]TypeInfo, size),
  455. }
  456. for keyIndex, keyColumn := range partitionKey {
  457. // set an indicator for checking if the mapping is missing
  458. routingKeyInfo.indexes[keyIndex] = -1
  459. // find the column in the query info
  460. for argIndex, boundColumn := range info.request.columns {
  461. if keyColumn.Name == boundColumn.Name {
  462. // there may be many such bound columns, pick the first
  463. routingKeyInfo.indexes[keyIndex] = argIndex
  464. routingKeyInfo.types[keyIndex] = boundColumn.TypeInfo
  465. break
  466. }
  467. }
  468. if routingKeyInfo.indexes[keyIndex] == -1 {
  469. // missing a routing key column mapping
  470. // no routing key, and no error
  471. return nil, nil
  472. }
  473. }
  474. // cache this result
  475. inflight.value = routingKeyInfo
  476. return routingKeyInfo, nil
  477. }
  478. func (b *Batch) execute(conn *Conn) *Iter {
  479. return conn.executeBatch(b)
  480. }
  481. func (s *Session) executeBatch(batch *Batch) *Iter {
  482. // fail fast
  483. if s.Closed() {
  484. return &Iter{err: ErrSessionClosed}
  485. }
  486. // Prevent the execution of the batch if greater than the limit
  487. // Currently batches have a limit of 65536 queries.
  488. // https://datastax-oss.atlassian.net/browse/JAVA-229
  489. if batch.Size() > BatchSizeMaximum {
  490. return &Iter{err: ErrTooManyStmts}
  491. }
  492. iter, err := s.executor.executeQuery(batch)
  493. if err != nil {
  494. return &Iter{err: err}
  495. }
  496. return iter
  497. }
  498. // ExecuteBatch executes a batch operation and returns nil if successful
  499. // otherwise an error is returned describing the failure.
  500. func (s *Session) ExecuteBatch(batch *Batch) error {
  501. iter := s.executeBatch(batch)
  502. return iter.Close()
  503. }
  504. // ExecuteBatchCAS executes a batch operation and returns true if successful and
  505. // an iterator (to scan aditional rows if more than one conditional statement)
  506. // was sent.
  507. // Further scans on the interator must also remember to include
  508. // the applied boolean as the first argument to *Iter.Scan
  509. func (s *Session) ExecuteBatchCAS(batch *Batch, dest ...interface{}) (applied bool, iter *Iter, err error) {
  510. iter = s.executeBatch(batch)
  511. if err := iter.checkErrAndNotFound(); err != nil {
  512. iter.Close()
  513. return false, nil, err
  514. }
  515. if len(iter.Columns()) > 1 {
  516. dest = append([]interface{}{&applied}, dest...)
  517. iter.Scan(dest...)
  518. } else {
  519. iter.Scan(&applied)
  520. }
  521. return applied, iter, nil
  522. }
  523. // MapExecuteBatchCAS executes a batch operation much like ExecuteBatchCAS,
  524. // however it accepts a map rather than a list of arguments for the initial
  525. // scan.
  526. func (s *Session) MapExecuteBatchCAS(batch *Batch, dest map[string]interface{}) (applied bool, iter *Iter, err error) {
  527. iter = s.executeBatch(batch)
  528. if err := iter.checkErrAndNotFound(); err != nil {
  529. iter.Close()
  530. return false, nil, err
  531. }
  532. iter.MapScan(dest)
  533. applied = dest["[applied]"].(bool)
  534. delete(dest, "[applied]")
  535. // we usually close here, but instead of closing, just returin an error
  536. // if MapScan failed. Although Close just returns err, using Close
  537. // here might be confusing as we are not actually closing the iter
  538. return applied, iter, iter.err
  539. }
  540. func (s *Session) connect(host *HostInfo, errorHandler ConnErrorHandler) (*Conn, error) {
  541. if s.connectObserver != nil {
  542. obs := ObservedConnect{
  543. Host: host,
  544. Start: time.Now(),
  545. }
  546. conn, err := s.dial(host, s.connCfg, errorHandler)
  547. obs.End = time.Now()
  548. obs.Err = err
  549. s.connectObserver.ObserveConnect(obs)
  550. return conn, err
  551. }
  552. return s.dial(host, s.connCfg, errorHandler)
  553. }
  554. // Query represents a CQL statement that can be executed.
  555. type Query struct {
  556. stmt string
  557. values []interface{}
  558. cons Consistency
  559. pageSize int
  560. routingKey []byte
  561. routingKeyBuffer []byte
  562. pageState []byte
  563. prefetch float64
  564. trace Tracer
  565. observer QueryObserver
  566. session *Session
  567. rt RetryPolicy
  568. binding func(q *QueryInfo) ([]interface{}, error)
  569. attempts int
  570. totalLatency int64
  571. serialCons SerialConsistency
  572. defaultTimestamp bool
  573. defaultTimestampValue int64
  574. disableSkipMetadata bool
  575. context context.Context
  576. idempotent bool
  577. disableAutoPage bool
  578. }
  579. func (q *Query) defaultsFromSession() {
  580. s := q.session
  581. s.mu.RLock()
  582. q.cons = s.cons
  583. q.pageSize = s.pageSize
  584. q.trace = s.trace
  585. q.observer = s.queryObserver
  586. q.prefetch = s.prefetch
  587. q.rt = s.cfg.RetryPolicy
  588. q.serialCons = s.cfg.SerialConsistency
  589. q.defaultTimestamp = s.cfg.DefaultTimestamp
  590. q.idempotent = s.cfg.DefaultIdempotence
  591. s.mu.RUnlock()
  592. }
  593. // Statement returns the statement that was used to generate this query.
  594. func (q Query) Statement() string {
  595. return q.stmt
  596. }
  597. // String implements the stringer interface.
  598. func (q Query) String() string {
  599. return fmt.Sprintf("[query statement=%q values=%+v consistency=%s]", q.stmt, q.values, q.cons)
  600. }
  601. //Attempts returns the number of times the query was executed.
  602. func (q *Query) Attempts() int {
  603. return q.attempts
  604. }
  605. //Latency returns the average amount of nanoseconds per attempt of the query.
  606. func (q *Query) Latency() int64 {
  607. if q.attempts > 0 {
  608. return q.totalLatency / int64(q.attempts)
  609. }
  610. return 0
  611. }
  612. // Consistency sets the consistency level for this query. If no consistency
  613. // level have been set, the default consistency level of the cluster
  614. // is used.
  615. func (q *Query) Consistency(c Consistency) *Query {
  616. q.cons = c
  617. return q
  618. }
  619. // GetConsistency returns the currently configured consistency level for
  620. // the query.
  621. func (q *Query) GetConsistency() Consistency {
  622. return q.cons
  623. }
  624. // Same as Consistency but without a return value
  625. func (q *Query) SetConsistency(c Consistency) {
  626. q.cons = c
  627. }
  628. // Trace enables tracing of this query. Look at the documentation of the
  629. // Tracer interface to learn more about tracing.
  630. func (q *Query) Trace(trace Tracer) *Query {
  631. q.trace = trace
  632. return q
  633. }
  634. // Observer enables query-level observer on this query.
  635. // The provided observer will be called every time this query is executed.
  636. func (q *Query) Observer(observer QueryObserver) *Query {
  637. q.observer = observer
  638. return q
  639. }
  640. // PageSize will tell the iterator to fetch the result in pages of size n.
  641. // This is useful for iterating over large result sets, but setting the
  642. // page size too low might decrease the performance. This feature is only
  643. // available in Cassandra 2 and onwards.
  644. func (q *Query) PageSize(n int) *Query {
  645. q.pageSize = n
  646. return q
  647. }
  648. // DefaultTimestamp will enable the with default timestamp flag on the query.
  649. // If enable, this will replace the server side assigned
  650. // timestamp as default timestamp. Note that a timestamp in the query itself
  651. // will still override this timestamp. This is entirely optional.
  652. //
  653. // Only available on protocol >= 3
  654. func (q *Query) DefaultTimestamp(enable bool) *Query {
  655. q.defaultTimestamp = enable
  656. return q
  657. }
  658. // WithTimestamp will enable the with default timestamp flag on the query
  659. // like DefaultTimestamp does. But also allows to define value for timestamp.
  660. // It works the same way as USING TIMESTAMP in the query itself, but
  661. // should not break prepared query optimization
  662. //
  663. // Only available on protocol >= 3
  664. func (q *Query) WithTimestamp(timestamp int64) *Query {
  665. q.DefaultTimestamp(true)
  666. q.defaultTimestampValue = timestamp
  667. return q
  668. }
  669. // RoutingKey sets the routing key to use when a token aware connection
  670. // pool is used to optimize the routing of this query.
  671. func (q *Query) RoutingKey(routingKey []byte) *Query {
  672. q.routingKey = routingKey
  673. return q
  674. }
  675. // WithContext will set the context to use during a query, it will be used to
  676. // timeout when waiting for responses from Cassandra.
  677. func (q *Query) WithContext(ctx context.Context) *Query {
  678. q.context = ctx
  679. return q
  680. }
  681. func (q *Query) execute(conn *Conn) *Iter {
  682. return conn.executeQuery(q)
  683. }
  684. func (q *Query) attempt(keyspace string, end, start time.Time, iter *Iter, address string) {
  685. q.attempts++
  686. q.totalLatency += end.Sub(start).Nanoseconds()
  687. // TODO: track latencies per host and things as well instead of just total
  688. if q.observer != nil {
  689. q.observer.ObserveQuery(q.context, ObservedQuery{
  690. Keyspace: keyspace,
  691. Statement: q.stmt,
  692. Start: start,
  693. End: end,
  694. Rows: iter.numRows,
  695. Host: address,
  696. Err: iter.err,
  697. })
  698. }
  699. }
  700. func (q *Query) retryPolicy() RetryPolicy {
  701. return q.rt
  702. }
  703. // Keyspace returns the keyspace the query will be executed against.
  704. func (q *Query) Keyspace() string {
  705. if q.session == nil {
  706. return ""
  707. }
  708. // TODO(chbannis): this should be parsed from the query or we should let
  709. // this be set by users.
  710. return q.session.cfg.Keyspace
  711. }
  712. // GetRoutingKey gets the routing key to use for routing this query. If
  713. // a routing key has not been explicitly set, then the routing key will
  714. // be constructed if possible using the keyspace's schema and the query
  715. // info for this query statement. If the routing key cannot be determined
  716. // then nil will be returned with no error. On any error condition,
  717. // an error description will be returned.
  718. func (q *Query) GetRoutingKey() ([]byte, error) {
  719. if q.routingKey != nil {
  720. return q.routingKey, nil
  721. } else if q.binding != nil && len(q.values) == 0 {
  722. // If this query was created using session.Bind we wont have the query
  723. // values yet, so we have to pass down to the next policy.
  724. // TODO: Remove this and handle this case
  725. return nil, nil
  726. }
  727. // try to determine the routing key
  728. routingKeyInfo, err := q.session.routingKeyInfo(q.context, q.stmt)
  729. if err != nil {
  730. return nil, err
  731. }
  732. if routingKeyInfo == nil {
  733. return nil, nil
  734. }
  735. if len(routingKeyInfo.indexes) == 1 {
  736. // single column routing key
  737. routingKey, err := Marshal(
  738. routingKeyInfo.types[0],
  739. q.values[routingKeyInfo.indexes[0]],
  740. )
  741. if err != nil {
  742. return nil, err
  743. }
  744. return routingKey, nil
  745. }
  746. // We allocate that buffer only once, so that further re-bind/exec of the
  747. // same query don't allocate more memory.
  748. if q.routingKeyBuffer == nil {
  749. q.routingKeyBuffer = make([]byte, 0, 256)
  750. }
  751. // composite routing key
  752. buf := bytes.NewBuffer(q.routingKeyBuffer)
  753. for i := range routingKeyInfo.indexes {
  754. encoded, err := Marshal(
  755. routingKeyInfo.types[i],
  756. q.values[routingKeyInfo.indexes[i]],
  757. )
  758. if err != nil {
  759. return nil, err
  760. }
  761. lenBuf := []byte{0x00, 0x00}
  762. binary.BigEndian.PutUint16(lenBuf, uint16(len(encoded)))
  763. buf.Write(lenBuf)
  764. buf.Write(encoded)
  765. buf.WriteByte(0x00)
  766. }
  767. routingKey := buf.Bytes()
  768. return routingKey, nil
  769. }
  770. func (q *Query) shouldPrepare() bool {
  771. stmt := strings.TrimLeftFunc(strings.TrimRightFunc(q.stmt, func(r rune) bool {
  772. return unicode.IsSpace(r) || r == ';'
  773. }), unicode.IsSpace)
  774. var stmtType string
  775. if n := strings.IndexFunc(stmt, unicode.IsSpace); n >= 0 {
  776. stmtType = strings.ToLower(stmt[:n])
  777. }
  778. if stmtType == "begin" {
  779. if n := strings.LastIndexFunc(stmt, unicode.IsSpace); n >= 0 {
  780. stmtType = strings.ToLower(stmt[n+1:])
  781. }
  782. }
  783. switch stmtType {
  784. case "select", "insert", "update", "delete", "batch":
  785. return true
  786. }
  787. return false
  788. }
  789. // SetPrefetch sets the default threshold for pre-fetching new pages. If
  790. // there are only p*pageSize rows remaining, the next page will be requested
  791. // automatically.
  792. func (q *Query) Prefetch(p float64) *Query {
  793. q.prefetch = p
  794. return q
  795. }
  796. // RetryPolicy sets the policy to use when retrying the query.
  797. func (q *Query) RetryPolicy(r RetryPolicy) *Query {
  798. q.rt = r
  799. return q
  800. }
  801. func (q *Query) IsIdempotent() bool {
  802. return q.idempotent
  803. }
  804. // Idempontent marks the query as being idempontent or not depending on
  805. // the value.
  806. func (q *Query) Idempontent(value bool) *Query {
  807. q.idempotent = value
  808. return q
  809. }
  810. // Bind sets query arguments of query. This can also be used to rebind new query arguments
  811. // to an existing query instance.
  812. func (q *Query) Bind(v ...interface{}) *Query {
  813. q.values = v
  814. return q
  815. }
  816. // SerialConsistency sets the consistency level for the
  817. // serial phase of conditional updates. That consistency can only be
  818. // either SERIAL or LOCAL_SERIAL and if not present, it defaults to
  819. // SERIAL. This option will be ignored for anything else that a
  820. // conditional update/insert.
  821. func (q *Query) SerialConsistency(cons SerialConsistency) *Query {
  822. q.serialCons = cons
  823. return q
  824. }
  825. // PageState sets the paging state for the query to resume paging from a specific
  826. // point in time. Setting this will disable to query paging for this query, and
  827. // must be used for all subsequent pages.
  828. func (q *Query) PageState(state []byte) *Query {
  829. q.pageState = state
  830. q.disableAutoPage = true
  831. return q
  832. }
  833. // NoSkipMetadata will override the internal result metadata cache so that the driver does not
  834. // send skip_metadata for queries, this means that the result will always contain
  835. // the metadata to parse the rows and will not reuse the metadata from the prepared
  836. // staement. This should only be used to work around cassandra bugs, such as when using
  837. // CAS operations which do not end in Cas.
  838. //
  839. // See https://issues.apache.org/jira/browse/CASSANDRA-11099
  840. // https://github.com/gocql/gocql/issues/612
  841. func (q *Query) NoSkipMetadata() *Query {
  842. q.disableSkipMetadata = true
  843. return q
  844. }
  845. // Exec executes the query without returning any rows.
  846. func (q *Query) Exec() error {
  847. return q.Iter().Close()
  848. }
  849. func isUseStatement(stmt string) bool {
  850. if len(stmt) < 3 {
  851. return false
  852. }
  853. return strings.EqualFold(stmt[0:3], "use")
  854. }
  855. // Iter executes the query and returns an iterator capable of iterating
  856. // over all results.
  857. func (q *Query) Iter() *Iter {
  858. if isUseStatement(q.stmt) {
  859. return &Iter{err: ErrUseStmt}
  860. }
  861. return q.session.executeQuery(q)
  862. }
  863. // MapScan executes the query, copies the columns of the first selected
  864. // row into the map pointed at by m and discards the rest. If no rows
  865. // were selected, ErrNotFound is returned.
  866. func (q *Query) MapScan(m map[string]interface{}) error {
  867. iter := q.Iter()
  868. if err := iter.checkErrAndNotFound(); err != nil {
  869. return err
  870. }
  871. iter.MapScan(m)
  872. return iter.Close()
  873. }
  874. // Scan executes the query, copies the columns of the first selected
  875. // row into the values pointed at by dest and discards the rest. If no rows
  876. // were selected, ErrNotFound is returned.
  877. func (q *Query) Scan(dest ...interface{}) error {
  878. iter := q.Iter()
  879. if err := iter.checkErrAndNotFound(); err != nil {
  880. return err
  881. }
  882. iter.Scan(dest...)
  883. return iter.Close()
  884. }
  885. // ScanCAS executes a lightweight transaction (i.e. an UPDATE or INSERT
  886. // statement containing an IF clause). If the transaction fails because
  887. // the existing values did not match, the previous values will be stored
  888. // in dest.
  889. func (q *Query) ScanCAS(dest ...interface{}) (applied bool, err error) {
  890. q.disableSkipMetadata = true
  891. iter := q.Iter()
  892. if err := iter.checkErrAndNotFound(); err != nil {
  893. return false, err
  894. }
  895. if len(iter.Columns()) > 1 {
  896. dest = append([]interface{}{&applied}, dest...)
  897. iter.Scan(dest...)
  898. } else {
  899. iter.Scan(&applied)
  900. }
  901. return applied, iter.Close()
  902. }
  903. // MapScanCAS executes a lightweight transaction (i.e. an UPDATE or INSERT
  904. // statement containing an IF clause). If the transaction fails because
  905. // the existing values did not match, the previous values will be stored
  906. // in dest map.
  907. //
  908. // As for INSERT .. IF NOT EXISTS, previous values will be returned as if
  909. // SELECT * FROM. So using ScanCAS with INSERT is inherently prone to
  910. // column mismatching. MapScanCAS is added to capture them safely.
  911. func (q *Query) MapScanCAS(dest map[string]interface{}) (applied bool, err error) {
  912. q.disableSkipMetadata = true
  913. iter := q.Iter()
  914. if err := iter.checkErrAndNotFound(); err != nil {
  915. return false, err
  916. }
  917. iter.MapScan(dest)
  918. applied = dest["[applied]"].(bool)
  919. delete(dest, "[applied]")
  920. return applied, iter.Close()
  921. }
  922. // Release releases a query back into a pool of queries. Released Queries
  923. // cannot be reused.
  924. //
  925. // Example:
  926. // qry := session.Query("SELECT * FROM my_table")
  927. // qry.Exec()
  928. // qry.Release()
  929. func (q *Query) Release() {
  930. q.reset()
  931. queryPool.Put(q)
  932. }
  933. // reset zeroes out all fields of a query so that it can be safely pooled.
  934. func (q *Query) reset() {
  935. *q = Query{}
  936. }
  937. // Iter represents an iterator that can be used to iterate over all rows that
  938. // were returned by a query. The iterator might send additional queries to the
  939. // database during the iteration if paging was enabled.
  940. type Iter struct {
  941. err error
  942. pos int
  943. meta resultMetadata
  944. numRows int
  945. next *nextIter
  946. host *HostInfo
  947. framer *framer
  948. closed int32
  949. }
  950. // Host returns the host which the query was sent to.
  951. func (iter *Iter) Host() *HostInfo {
  952. return iter.host
  953. }
  954. // Columns returns the name and type of the selected columns.
  955. func (iter *Iter) Columns() []ColumnInfo {
  956. return iter.meta.columns
  957. }
  958. type Scanner interface {
  959. // Next advances the row pointer to point at the next row, the row is valid until
  960. // the next call of Next. It returns true if there is a row which is available to be
  961. // scanned into with Scan.
  962. // Next must be called before every call to Scan.
  963. Next() bool
  964. // Scan copies the current row's columns into dest. If the length of dest does not equal
  965. // the number of columns returned in the row an error is returned. If an error is encountered
  966. // when unmarshalling a column into the value in dest an error is returned and the row is invalidated
  967. // until the next call to Next.
  968. // Next must be called before calling Scan, if it is not an error is returned.
  969. Scan(...interface{}) error
  970. // Err returns the if there was one during iteration that resulted in iteration being unable to complete.
  971. // Err will also release resources held by the iterator, the Scanner should not used after being called.
  972. Err() error
  973. }
  974. type iterScanner struct {
  975. iter *Iter
  976. cols [][]byte
  977. valid bool
  978. }
  979. func (is *iterScanner) Next() bool {
  980. iter := is.iter
  981. if iter.err != nil {
  982. return false
  983. }
  984. if iter.pos >= iter.numRows {
  985. if iter.next != nil {
  986. is.iter = iter.next.fetch()
  987. return is.Next()
  988. }
  989. return false
  990. }
  991. for i := 0; i < len(is.cols); i++ {
  992. col, err := iter.readColumn()
  993. if err != nil {
  994. iter.err = err
  995. return false
  996. }
  997. is.cols[i] = col
  998. }
  999. iter.pos++
  1000. is.valid = true
  1001. return true
  1002. }
  1003. func scanColumn(p []byte, col ColumnInfo, dest []interface{}) (int, error) {
  1004. if dest[0] == nil {
  1005. return 1, nil
  1006. }
  1007. if col.TypeInfo.Type() == TypeTuple {
  1008. // this will panic, actually a bug, please report
  1009. tuple := col.TypeInfo.(TupleTypeInfo)
  1010. count := len(tuple.Elems)
  1011. // here we pass in a slice of the struct which has the number number of
  1012. // values as elements in the tuple
  1013. if err := Unmarshal(col.TypeInfo, p, dest[:count]); err != nil {
  1014. return 0, err
  1015. }
  1016. return count, nil
  1017. } else {
  1018. if err := Unmarshal(col.TypeInfo, p, dest[0]); err != nil {
  1019. return 0, err
  1020. }
  1021. return 1, nil
  1022. }
  1023. }
  1024. func (is *iterScanner) Scan(dest ...interface{}) error {
  1025. if !is.valid {
  1026. return errors.New("gocql: Scan called without calling Next")
  1027. }
  1028. iter := is.iter
  1029. // currently only support scanning into an expand tuple, such that its the same
  1030. // as scanning in more values from a single column
  1031. if len(dest) != iter.meta.actualColCount {
  1032. return fmt.Errorf("gocql: not enough columns to scan into: have %d want %d", len(dest), iter.meta.actualColCount)
  1033. }
  1034. // i is the current position in dest, could posible replace it and just use
  1035. // slices of dest
  1036. i := 0
  1037. var err error
  1038. for _, col := range iter.meta.columns {
  1039. var n int
  1040. n, err = scanColumn(is.cols[i], col, dest[i:])
  1041. if err != nil {
  1042. break
  1043. }
  1044. i += n
  1045. }
  1046. is.valid = false
  1047. return err
  1048. }
  1049. func (is *iterScanner) Err() error {
  1050. iter := is.iter
  1051. is.iter = nil
  1052. is.cols = nil
  1053. is.valid = false
  1054. return iter.Close()
  1055. }
  1056. // Scanner returns a row Scanner which provides an interface to scan rows in a manner which is
  1057. // similar to database/sql. The iter should NOT be used again after calling this method.
  1058. func (iter *Iter) Scanner() Scanner {
  1059. if iter == nil {
  1060. return nil
  1061. }
  1062. return &iterScanner{iter: iter, cols: make([][]byte, len(iter.meta.columns))}
  1063. }
  1064. func (iter *Iter) readColumn() ([]byte, error) {
  1065. return iter.framer.readBytesInternal()
  1066. }
  1067. // Scan consumes the next row of the iterator and copies the columns of the
  1068. // current row into the values pointed at by dest. Use nil as a dest value
  1069. // to skip the corresponding column. Scan might send additional queries
  1070. // to the database to retrieve the next set of rows if paging was enabled.
  1071. //
  1072. // Scan returns true if the row was successfully unmarshaled or false if the
  1073. // end of the result set was reached or if an error occurred. Close should
  1074. // be called afterwards to retrieve any potential errors.
  1075. func (iter *Iter) Scan(dest ...interface{}) bool {
  1076. if iter.err != nil {
  1077. return false
  1078. }
  1079. if iter.pos >= iter.numRows {
  1080. if iter.next != nil {
  1081. *iter = *iter.next.fetch()
  1082. return iter.Scan(dest...)
  1083. }
  1084. return false
  1085. }
  1086. if iter.next != nil && iter.pos == iter.next.pos {
  1087. go iter.next.fetch()
  1088. }
  1089. // currently only support scanning into an expand tuple, such that its the same
  1090. // as scanning in more values from a single column
  1091. if len(dest) != iter.meta.actualColCount {
  1092. iter.err = fmt.Errorf("gocql: not enough columns to scan into: have %d want %d", len(dest), iter.meta.actualColCount)
  1093. return false
  1094. }
  1095. // i is the current position in dest, could posible replace it and just use
  1096. // slices of dest
  1097. i := 0
  1098. for _, col := range iter.meta.columns {
  1099. colBytes, err := iter.readColumn()
  1100. if err != nil {
  1101. iter.err = err
  1102. return false
  1103. }
  1104. n, err := scanColumn(colBytes, col, dest[i:])
  1105. if err != nil {
  1106. iter.err = err
  1107. return false
  1108. }
  1109. i += n
  1110. }
  1111. iter.pos++
  1112. return true
  1113. }
  1114. // GetCustomPayload returns any parsed custom payload results if given in the
  1115. // response from Cassandra. Note that the result is not a copy.
  1116. //
  1117. // This additional feature of CQL Protocol v4
  1118. // allows additional results and query information to be returned by
  1119. // custom QueryHandlers running in your C* cluster.
  1120. // See https://datastax.github.io/java-driver/manual/custom_payloads/
  1121. func (iter *Iter) GetCustomPayload() map[string][]byte {
  1122. return iter.framer.header.customPayload
  1123. }
  1124. // Warnings returns any warnings generated if given in the response from Cassandra.
  1125. //
  1126. // This is only available starting with CQL Protocol v4.
  1127. func (iter *Iter) Warnings() []string {
  1128. if iter.framer != nil {
  1129. return iter.framer.header.warnings
  1130. }
  1131. return nil
  1132. }
  1133. // Close closes the iterator and returns any errors that happened during
  1134. // the query or the iteration.
  1135. func (iter *Iter) Close() error {
  1136. if atomic.CompareAndSwapInt32(&iter.closed, 0, 1) {
  1137. if iter.framer != nil {
  1138. iter.framer = nil
  1139. }
  1140. }
  1141. return iter.err
  1142. }
  1143. // WillSwitchPage detects if iterator reached end of current page
  1144. // and the next page is available.
  1145. func (iter *Iter) WillSwitchPage() bool {
  1146. return iter.pos >= iter.numRows && iter.next != nil
  1147. }
  1148. // checkErrAndNotFound handle error and NotFound in one method.
  1149. func (iter *Iter) checkErrAndNotFound() error {
  1150. if iter.err != nil {
  1151. return iter.err
  1152. } else if iter.numRows == 0 {
  1153. return ErrNotFound
  1154. }
  1155. return nil
  1156. }
  1157. // PageState return the current paging state for a query which can be used for
  1158. // subsequent quries to resume paging this point.
  1159. func (iter *Iter) PageState() []byte {
  1160. return iter.meta.pagingState
  1161. }
  1162. // NumRows returns the number of rows in this pagination, it will update when new
  1163. // pages are fetched, it is not the value of the total number of rows this iter
  1164. // will return unless there is only a single page returned.
  1165. func (iter *Iter) NumRows() int {
  1166. return iter.numRows
  1167. }
  1168. type nextIter struct {
  1169. qry Query
  1170. pos int
  1171. once sync.Once
  1172. next *Iter
  1173. conn *Conn
  1174. }
  1175. func (n *nextIter) fetch() *Iter {
  1176. n.once.Do(func() {
  1177. iter := n.qry.session.executor.attemptQuery(&n.qry, n.conn)
  1178. if iter != nil && iter.err == nil {
  1179. n.next = iter
  1180. } else {
  1181. n.next = n.qry.session.executeQuery(&n.qry)
  1182. }
  1183. })
  1184. return n.next
  1185. }
  1186. type Batch struct {
  1187. Type BatchType
  1188. Entries []BatchEntry
  1189. Cons Consistency
  1190. rt RetryPolicy
  1191. observer BatchObserver
  1192. attempts int
  1193. totalLatency int64
  1194. serialCons SerialConsistency
  1195. defaultTimestamp bool
  1196. defaultTimestampValue int64
  1197. context context.Context
  1198. keyspace string
  1199. }
  1200. // NewBatch creates a new batch operation without defaults from the cluster
  1201. //
  1202. // Depreicated: use session.NewBatch instead
  1203. func NewBatch(typ BatchType) *Batch {
  1204. return &Batch{Type: typ}
  1205. }
  1206. // NewBatch creates a new batch operation using defaults defined in the cluster
  1207. func (s *Session) NewBatch(typ BatchType) *Batch {
  1208. s.mu.RLock()
  1209. batch := &Batch{
  1210. Type: typ,
  1211. rt: s.cfg.RetryPolicy,
  1212. serialCons: s.cfg.SerialConsistency,
  1213. observer: s.batchObserver,
  1214. Cons: s.cons,
  1215. defaultTimestamp: s.cfg.DefaultTimestamp,
  1216. keyspace: s.cfg.Keyspace,
  1217. }
  1218. s.mu.RUnlock()
  1219. return batch
  1220. }
  1221. // Observer enables batch-level observer on this batch.
  1222. // The provided observer will be called every time this batched query is executed.
  1223. func (b *Batch) Observer(observer BatchObserver) *Batch {
  1224. b.observer = observer
  1225. return b
  1226. }
  1227. func (b *Batch) Keyspace() string {
  1228. return b.keyspace
  1229. }
  1230. // Attempts returns the number of attempts made to execute the batch.
  1231. func (b *Batch) Attempts() int {
  1232. return b.attempts
  1233. }
  1234. //Latency returns the average number of nanoseconds to execute a single attempt of the batch.
  1235. func (b *Batch) Latency() int64 {
  1236. if b.attempts > 0 {
  1237. return b.totalLatency / int64(b.attempts)
  1238. }
  1239. return 0
  1240. }
  1241. // GetConsistency returns the currently configured consistency level for the batch
  1242. // operation.
  1243. func (b *Batch) GetConsistency() Consistency {
  1244. return b.Cons
  1245. }
  1246. // SetConsistency sets the currently configured consistency level for the batch
  1247. // operation.
  1248. func (b *Batch) SetConsistency(c Consistency) {
  1249. b.Cons = c
  1250. }
  1251. // Query adds the query to the batch operation
  1252. func (b *Batch) Query(stmt string, args ...interface{}) {
  1253. b.Entries = append(b.Entries, BatchEntry{Stmt: stmt, Args: args})
  1254. }
  1255. // Bind adds the query to the batch operation and correlates it with a binding callback
  1256. // that will be invoked when the batch is executed. The binding callback allows the application
  1257. // to define which query argument values will be marshalled as part of the batch execution.
  1258. func (b *Batch) Bind(stmt string, bind func(q *QueryInfo) ([]interface{}, error)) {
  1259. b.Entries = append(b.Entries, BatchEntry{Stmt: stmt, binding: bind})
  1260. }
  1261. func (b *Batch) retryPolicy() RetryPolicy {
  1262. return b.rt
  1263. }
  1264. // RetryPolicy sets the retry policy to use when executing the batch operation
  1265. func (b *Batch) RetryPolicy(r RetryPolicy) *Batch {
  1266. b.rt = r
  1267. return b
  1268. }
  1269. // WithContext will set the context to use during a query, it will be used to
  1270. // timeout when waiting for responses from Cassandra.
  1271. func (b *Batch) WithContext(ctx context.Context) *Batch {
  1272. b.context = ctx
  1273. return b
  1274. }
  1275. // Size returns the number of batch statements to be executed by the batch operation.
  1276. func (b *Batch) Size() int {
  1277. return len(b.Entries)
  1278. }
  1279. // SerialConsistency sets the consistency level for the
  1280. // serial phase of conditional updates. That consistency can only be
  1281. // either SERIAL or LOCAL_SERIAL and if not present, it defaults to
  1282. // SERIAL. This option will be ignored for anything else that a
  1283. // conditional update/insert.
  1284. //
  1285. // Only available for protocol 3 and above
  1286. func (b *Batch) SerialConsistency(cons SerialConsistency) *Batch {
  1287. b.serialCons = cons
  1288. return b
  1289. }
  1290. // DefaultTimestamp will enable the with default timestamp flag on the query.
  1291. // If enable, this will replace the server side assigned
  1292. // timestamp as default timestamp. Note that a timestamp in the query itself
  1293. // will still override this timestamp. This is entirely optional.
  1294. //
  1295. // Only available on protocol >= 3
  1296. func (b *Batch) DefaultTimestamp(enable bool) *Batch {
  1297. b.defaultTimestamp = enable
  1298. return b
  1299. }
  1300. // WithTimestamp will enable the with default timestamp flag on the query
  1301. // like DefaultTimestamp does. But also allows to define value for timestamp.
  1302. // It works the same way as USING TIMESTAMP in the query itself, but
  1303. // should not break prepared query optimization
  1304. //
  1305. // Only available on protocol >= 3
  1306. func (b *Batch) WithTimestamp(timestamp int64) *Batch {
  1307. b.DefaultTimestamp(true)
  1308. b.defaultTimestampValue = timestamp
  1309. return b
  1310. }
  1311. func (b *Batch) attempt(keyspace string, end, start time.Time, iter *Iter, address string) {
  1312. b.attempts++
  1313. b.totalLatency += end.Sub(start).Nanoseconds()
  1314. // TODO: track latencies per host and things as well instead of just total
  1315. if b.observer == nil {
  1316. return
  1317. }
  1318. statements := make([]string, len(b.Entries))
  1319. for i, entry := range b.Entries {
  1320. statements[i] = entry.Stmt
  1321. }
  1322. b.observer.ObserveBatch(b.context, ObservedBatch{
  1323. Keyspace: keyspace,
  1324. Statements: statements,
  1325. Start: start,
  1326. End: end,
  1327. // Rows not used in batch observations // TODO - might be able to support it when using BatchCAS
  1328. Host: address,
  1329. Err: iter.err,
  1330. })
  1331. }
  1332. func (b *Batch) GetRoutingKey() ([]byte, error) {
  1333. // TODO: use the first statement in the batch as the routing key?
  1334. return nil, nil
  1335. }
  1336. type BatchType byte
  1337. const (
  1338. LoggedBatch BatchType = 0
  1339. UnloggedBatch BatchType = 1
  1340. CounterBatch BatchType = 2
  1341. )
  1342. type BatchEntry struct {
  1343. Stmt string
  1344. Args []interface{}
  1345. binding func(q *QueryInfo) ([]interface{}, error)
  1346. }
  1347. type ColumnInfo struct {
  1348. Keyspace string
  1349. Table string
  1350. Name string
  1351. TypeInfo TypeInfo
  1352. }
  1353. func (c ColumnInfo) String() string {
  1354. return fmt.Sprintf("[column keyspace=%s table=%s name=%s type=%v]", c.Keyspace, c.Table, c.Name, c.TypeInfo)
  1355. }
  1356. // routing key indexes LRU cache
  1357. type routingKeyInfoLRU struct {
  1358. lru *lru.Cache
  1359. mu sync.Mutex
  1360. }
  1361. type routingKeyInfo struct {
  1362. indexes []int
  1363. types []TypeInfo
  1364. }
  1365. func (r *routingKeyInfo) String() string {
  1366. return fmt.Sprintf("routing key index=%v types=%v", r.indexes, r.types)
  1367. }
  1368. func (r *routingKeyInfoLRU) Remove(key string) {
  1369. r.mu.Lock()
  1370. r.lru.Remove(key)
  1371. r.mu.Unlock()
  1372. }
  1373. //Max adjusts the maximum size of the cache and cleans up the oldest records if
  1374. //the new max is lower than the previous value. Not concurrency safe.
  1375. func (r *routingKeyInfoLRU) Max(max int) {
  1376. r.mu.Lock()
  1377. for r.lru.Len() > max {
  1378. r.lru.RemoveOldest()
  1379. }
  1380. r.lru.MaxEntries = max
  1381. r.mu.Unlock()
  1382. }
  1383. type inflightCachedEntry struct {
  1384. wg sync.WaitGroup
  1385. err error
  1386. value interface{}
  1387. }
  1388. // Tracer is the interface implemented by query tracers. Tracers have the
  1389. // ability to obtain a detailed event log of all events that happened during
  1390. // the execution of a query from Cassandra. Gathering this information might
  1391. // be essential for debugging and optimizing queries, but this feature should
  1392. // not be used on production systems with very high load.
  1393. type Tracer interface {
  1394. Trace(traceId []byte)
  1395. }
  1396. type traceWriter struct {
  1397. session *Session
  1398. w io.Writer
  1399. mu sync.Mutex
  1400. }
  1401. // NewTraceWriter returns a simple Tracer implementation that outputs
  1402. // the event log in a textual format.
  1403. func NewTraceWriter(session *Session, w io.Writer) Tracer {
  1404. return &traceWriter{session: session, w: w}
  1405. }
  1406. func (t *traceWriter) Trace(traceId []byte) {
  1407. var (
  1408. coordinator string
  1409. duration int
  1410. )
  1411. iter := t.session.control.query(`SELECT coordinator, duration
  1412. FROM system_traces.sessions
  1413. WHERE session_id = ?`, traceId)
  1414. iter.Scan(&coordinator, &duration)
  1415. if err := iter.Close(); err != nil {
  1416. t.mu.Lock()
  1417. fmt.Fprintln(t.w, "Error:", err)
  1418. t.mu.Unlock()
  1419. return
  1420. }
  1421. var (
  1422. timestamp time.Time
  1423. activity string
  1424. source string
  1425. elapsed int
  1426. )
  1427. t.mu.Lock()
  1428. defer t.mu.Unlock()
  1429. fmt.Fprintf(t.w, "Tracing session %016x (coordinator: %s, duration: %v):\n",
  1430. traceId, coordinator, time.Duration(duration)*time.Microsecond)
  1431. iter = t.session.control.query(`SELECT event_id, activity, source, source_elapsed
  1432. FROM system_traces.events
  1433. WHERE session_id = ?`, traceId)
  1434. for iter.Scan(&timestamp, &activity, &source, &elapsed) {
  1435. fmt.Fprintf(t.w, "%s: %s (source: %s, elapsed: %d)\n",
  1436. timestamp.Format("2006/01/02 15:04:05.999999"), activity, source, elapsed)
  1437. }
  1438. if err := iter.Close(); err != nil {
  1439. fmt.Fprintln(t.w, "Error:", err)
  1440. }
  1441. }
  1442. type ObservedQuery struct {
  1443. Keyspace string
  1444. Statement string
  1445. Start time.Time // time immediately before the query was called
  1446. End time.Time // time immediately after the query returned
  1447. // Rows is the number of rows in the current iter.
  1448. // In paginated queries, rows from previous scans are not counted.
  1449. // Rows is not used in batch queries and remains at the default value
  1450. Rows int
  1451. // Host is the informations about the host that performed the query
  1452. Host string
  1453. // Err is the error in the query.
  1454. // It only tracks network errors or errors of bad cassandra syntax, in particular selects with no match return nil error
  1455. Err error
  1456. }
  1457. // QueryObserver is the interface implemented by query observers / stat collectors.
  1458. //
  1459. // Experimental, this interface and use may change
  1460. type QueryObserver interface {
  1461. // ObserveQuery gets called on every query to cassandra, including all queries in an iterator when paging is enabled.
  1462. // It doesn't get called if there is no query because the session is closed or there are no connections available.
  1463. // The error reported only shows query errors, i.e. if a SELECT is valid but finds no matches it will be nil.
  1464. ObserveQuery(context.Context, ObservedQuery)
  1465. }
  1466. type ObservedBatch struct {
  1467. Keyspace string
  1468. Statements []string
  1469. Start time.Time // time immediately before the batch query was called
  1470. End time.Time // time immediately after the batch query returned
  1471. // Host is the informations about the host that performed the batch
  1472. Host string
  1473. // Err is the error in the batch query.
  1474. // It only tracks network errors or errors of bad cassandra syntax, in particular selects with no match return nil error
  1475. Err error
  1476. }
  1477. // BatchObserver is the interface implemented by batch observers / stat collectors.
  1478. type BatchObserver interface {
  1479. // ObserveBatch gets called on every batch query to cassandra.
  1480. // It also gets called once for each query in a batch.
  1481. // It doesn't get called if there is no query because the session is closed or there are no connections available.
  1482. // The error reported only shows query errors, i.e. if a SELECT is valid but finds no matches it will be nil.
  1483. // Unlike QueryObserver.ObserveQuery it does no reporting on rows read.
  1484. ObserveBatch(context.Context, ObservedBatch)
  1485. }
  1486. type ObservedConnect struct {
  1487. // Host is the information about the host about to connect
  1488. Host *HostInfo
  1489. Start time.Time // time immediately before the dial is called
  1490. End time.Time // time immediately after the dial returned
  1491. // Err is the connection error (if any)
  1492. Err error
  1493. }
  1494. // ConnectObserver is the interface implemented by connect observers / stat collectors.
  1495. type ConnectObserver interface {
  1496. // ObserveConnect gets called when a new connection to cassandra is made.
  1497. ObserveConnect(ObservedConnect)
  1498. }
  1499. type Error struct {
  1500. Code int
  1501. Message string
  1502. }
  1503. func (e Error) Error() string {
  1504. return e.Message
  1505. }
  1506. var (
  1507. ErrNotFound = errors.New("not found")
  1508. ErrUnavailable = errors.New("unavailable")
  1509. ErrUnsupported = errors.New("feature not supported")
  1510. ErrTooManyStmts = errors.New("too many statements")
  1511. ErrUseStmt = errors.New("use statements aren't supported. Please see https://github.com/gocql/gocql for explanation.")
  1512. ErrSessionClosed = errors.New("session has been closed")
  1513. ErrNoConnections = errors.New("gocql: no hosts available in the pool")
  1514. ErrNoKeyspace = errors.New("no keyspace provided")
  1515. ErrKeyspaceDoesNotExist = errors.New("keyspace does not exist")
  1516. ErrNoMetadata = errors.New("no metadata available")
  1517. )
  1518. type ErrProtocol struct{ error }
  1519. func NewErrProtocol(format string, args ...interface{}) error {
  1520. return ErrProtocol{fmt.Errorf(format, args...)}
  1521. }
  1522. // BatchSizeMaximum is the maximum number of statements a batch operation can have.
  1523. // This limit is set by cassandra and could change in the future.
  1524. const BatchSizeMaximum = 65535