github.com/NpoolPlatform/chain-middleware@v0.0.0-20240228100535-eb1bcf896eb9/pkg/db/ent/coindescription_query.go (about)

     1  // Code generated by ent, DO NOT EDIT.
     2  
     3  package ent
     4  
     5  import (
     6  	"context"
     7  	"errors"
     8  	"fmt"
     9  	"math"
    10  
    11  	"entgo.io/ent/dialect"
    12  	"entgo.io/ent/dialect/sql"
    13  	"entgo.io/ent/dialect/sql/sqlgraph"
    14  	"entgo.io/ent/schema/field"
    15  	"github.com/NpoolPlatform/chain-middleware/pkg/db/ent/coindescription"
    16  	"github.com/NpoolPlatform/chain-middleware/pkg/db/ent/predicate"
    17  )
    18  
    19  // CoinDescriptionQuery is the builder for querying CoinDescription entities.
    20  type CoinDescriptionQuery struct {
    21  	config
    22  	limit      *int
    23  	offset     *int
    24  	unique     *bool
    25  	order      []OrderFunc
    26  	fields     []string
    27  	predicates []predicate.CoinDescription
    28  	modifiers  []func(*sql.Selector)
    29  	// intermediate query (i.e. traversal path).
    30  	sql  *sql.Selector
    31  	path func(context.Context) (*sql.Selector, error)
    32  }
    33  
    34  // Where adds a new predicate for the CoinDescriptionQuery builder.
    35  func (cdq *CoinDescriptionQuery) Where(ps ...predicate.CoinDescription) *CoinDescriptionQuery {
    36  	cdq.predicates = append(cdq.predicates, ps...)
    37  	return cdq
    38  }
    39  
    40  // Limit adds a limit step to the query.
    41  func (cdq *CoinDescriptionQuery) Limit(limit int) *CoinDescriptionQuery {
    42  	cdq.limit = &limit
    43  	return cdq
    44  }
    45  
    46  // Offset adds an offset step to the query.
    47  func (cdq *CoinDescriptionQuery) Offset(offset int) *CoinDescriptionQuery {
    48  	cdq.offset = &offset
    49  	return cdq
    50  }
    51  
    52  // Unique configures the query builder to filter duplicate records on query.
    53  // By default, unique is set to true, and can be disabled using this method.
    54  func (cdq *CoinDescriptionQuery) Unique(unique bool) *CoinDescriptionQuery {
    55  	cdq.unique = &unique
    56  	return cdq
    57  }
    58  
    59  // Order adds an order step to the query.
    60  func (cdq *CoinDescriptionQuery) Order(o ...OrderFunc) *CoinDescriptionQuery {
    61  	cdq.order = append(cdq.order, o...)
    62  	return cdq
    63  }
    64  
    65  // First returns the first CoinDescription entity from the query.
    66  // Returns a *NotFoundError when no CoinDescription was found.
    67  func (cdq *CoinDescriptionQuery) First(ctx context.Context) (*CoinDescription, error) {
    68  	nodes, err := cdq.Limit(1).All(ctx)
    69  	if err != nil {
    70  		return nil, err
    71  	}
    72  	if len(nodes) == 0 {
    73  		return nil, &NotFoundError{coindescription.Label}
    74  	}
    75  	return nodes[0], nil
    76  }
    77  
    78  // FirstX is like First, but panics if an error occurs.
    79  func (cdq *CoinDescriptionQuery) FirstX(ctx context.Context) *CoinDescription {
    80  	node, err := cdq.First(ctx)
    81  	if err != nil && !IsNotFound(err) {
    82  		panic(err)
    83  	}
    84  	return node
    85  }
    86  
    87  // FirstID returns the first CoinDescription ID from the query.
    88  // Returns a *NotFoundError when no CoinDescription ID was found.
    89  func (cdq *CoinDescriptionQuery) FirstID(ctx context.Context) (id uint32, err error) {
    90  	var ids []uint32
    91  	if ids, err = cdq.Limit(1).IDs(ctx); err != nil {
    92  		return
    93  	}
    94  	if len(ids) == 0 {
    95  		err = &NotFoundError{coindescription.Label}
    96  		return
    97  	}
    98  	return ids[0], nil
    99  }
   100  
   101  // FirstIDX is like FirstID, but panics if an error occurs.
   102  func (cdq *CoinDescriptionQuery) FirstIDX(ctx context.Context) uint32 {
   103  	id, err := cdq.FirstID(ctx)
   104  	if err != nil && !IsNotFound(err) {
   105  		panic(err)
   106  	}
   107  	return id
   108  }
   109  
   110  // Only returns a single CoinDescription entity found by the query, ensuring it only returns one.
   111  // Returns a *NotSingularError when more than one CoinDescription entity is found.
   112  // Returns a *NotFoundError when no CoinDescription entities are found.
   113  func (cdq *CoinDescriptionQuery) Only(ctx context.Context) (*CoinDescription, error) {
   114  	nodes, err := cdq.Limit(2).All(ctx)
   115  	if err != nil {
   116  		return nil, err
   117  	}
   118  	switch len(nodes) {
   119  	case 1:
   120  		return nodes[0], nil
   121  	case 0:
   122  		return nil, &NotFoundError{coindescription.Label}
   123  	default:
   124  		return nil, &NotSingularError{coindescription.Label}
   125  	}
   126  }
   127  
   128  // OnlyX is like Only, but panics if an error occurs.
   129  func (cdq *CoinDescriptionQuery) OnlyX(ctx context.Context) *CoinDescription {
   130  	node, err := cdq.Only(ctx)
   131  	if err != nil {
   132  		panic(err)
   133  	}
   134  	return node
   135  }
   136  
   137  // OnlyID is like Only, but returns the only CoinDescription ID in the query.
   138  // Returns a *NotSingularError when more than one CoinDescription ID is found.
   139  // Returns a *NotFoundError when no entities are found.
   140  func (cdq *CoinDescriptionQuery) OnlyID(ctx context.Context) (id uint32, err error) {
   141  	var ids []uint32
   142  	if ids, err = cdq.Limit(2).IDs(ctx); err != nil {
   143  		return
   144  	}
   145  	switch len(ids) {
   146  	case 1:
   147  		id = ids[0]
   148  	case 0:
   149  		err = &NotFoundError{coindescription.Label}
   150  	default:
   151  		err = &NotSingularError{coindescription.Label}
   152  	}
   153  	return
   154  }
   155  
   156  // OnlyIDX is like OnlyID, but panics if an error occurs.
   157  func (cdq *CoinDescriptionQuery) OnlyIDX(ctx context.Context) uint32 {
   158  	id, err := cdq.OnlyID(ctx)
   159  	if err != nil {
   160  		panic(err)
   161  	}
   162  	return id
   163  }
   164  
   165  // All executes the query and returns a list of CoinDescriptions.
   166  func (cdq *CoinDescriptionQuery) All(ctx context.Context) ([]*CoinDescription, error) {
   167  	if err := cdq.prepareQuery(ctx); err != nil {
   168  		return nil, err
   169  	}
   170  	return cdq.sqlAll(ctx)
   171  }
   172  
   173  // AllX is like All, but panics if an error occurs.
   174  func (cdq *CoinDescriptionQuery) AllX(ctx context.Context) []*CoinDescription {
   175  	nodes, err := cdq.All(ctx)
   176  	if err != nil {
   177  		panic(err)
   178  	}
   179  	return nodes
   180  }
   181  
   182  // IDs executes the query and returns a list of CoinDescription IDs.
   183  func (cdq *CoinDescriptionQuery) IDs(ctx context.Context) ([]uint32, error) {
   184  	var ids []uint32
   185  	if err := cdq.Select(coindescription.FieldID).Scan(ctx, &ids); err != nil {
   186  		return nil, err
   187  	}
   188  	return ids, nil
   189  }
   190  
   191  // IDsX is like IDs, but panics if an error occurs.
   192  func (cdq *CoinDescriptionQuery) IDsX(ctx context.Context) []uint32 {
   193  	ids, err := cdq.IDs(ctx)
   194  	if err != nil {
   195  		panic(err)
   196  	}
   197  	return ids
   198  }
   199  
   200  // Count returns the count of the given query.
   201  func (cdq *CoinDescriptionQuery) Count(ctx context.Context) (int, error) {
   202  	if err := cdq.prepareQuery(ctx); err != nil {
   203  		return 0, err
   204  	}
   205  	return cdq.sqlCount(ctx)
   206  }
   207  
   208  // CountX is like Count, but panics if an error occurs.
   209  func (cdq *CoinDescriptionQuery) CountX(ctx context.Context) int {
   210  	count, err := cdq.Count(ctx)
   211  	if err != nil {
   212  		panic(err)
   213  	}
   214  	return count
   215  }
   216  
   217  // Exist returns true if the query has elements in the graph.
   218  func (cdq *CoinDescriptionQuery) Exist(ctx context.Context) (bool, error) {
   219  	if err := cdq.prepareQuery(ctx); err != nil {
   220  		return false, err
   221  	}
   222  	return cdq.sqlExist(ctx)
   223  }
   224  
   225  // ExistX is like Exist, but panics if an error occurs.
   226  func (cdq *CoinDescriptionQuery) ExistX(ctx context.Context) bool {
   227  	exist, err := cdq.Exist(ctx)
   228  	if err != nil {
   229  		panic(err)
   230  	}
   231  	return exist
   232  }
   233  
   234  // Clone returns a duplicate of the CoinDescriptionQuery builder, including all associated steps. It can be
   235  // used to prepare common query builders and use them differently after the clone is made.
   236  func (cdq *CoinDescriptionQuery) Clone() *CoinDescriptionQuery {
   237  	if cdq == nil {
   238  		return nil
   239  	}
   240  	return &CoinDescriptionQuery{
   241  		config:     cdq.config,
   242  		limit:      cdq.limit,
   243  		offset:     cdq.offset,
   244  		order:      append([]OrderFunc{}, cdq.order...),
   245  		predicates: append([]predicate.CoinDescription{}, cdq.predicates...),
   246  		// clone intermediate query.
   247  		sql:    cdq.sql.Clone(),
   248  		path:   cdq.path,
   249  		unique: cdq.unique,
   250  	}
   251  }
   252  
   253  // GroupBy is used to group vertices by one or more fields/columns.
   254  // It is often used with aggregate functions, like: count, max, mean, min, sum.
   255  //
   256  // Example:
   257  //
   258  //	var v []struct {
   259  //		CreatedAt uint32 `json:"created_at,omitempty"`
   260  //		Count int `json:"count,omitempty"`
   261  //	}
   262  //
   263  //	client.CoinDescription.Query().
   264  //		GroupBy(coindescription.FieldCreatedAt).
   265  //		Aggregate(ent.Count()).
   266  //		Scan(ctx, &v)
   267  //
   268  func (cdq *CoinDescriptionQuery) GroupBy(field string, fields ...string) *CoinDescriptionGroupBy {
   269  	grbuild := &CoinDescriptionGroupBy{config: cdq.config}
   270  	grbuild.fields = append([]string{field}, fields...)
   271  	grbuild.path = func(ctx context.Context) (prev *sql.Selector, err error) {
   272  		if err := cdq.prepareQuery(ctx); err != nil {
   273  			return nil, err
   274  		}
   275  		return cdq.sqlQuery(ctx), nil
   276  	}
   277  	grbuild.label = coindescription.Label
   278  	grbuild.flds, grbuild.scan = &grbuild.fields, grbuild.Scan
   279  	return grbuild
   280  }
   281  
   282  // Select allows the selection one or more fields/columns for the given query,
   283  // instead of selecting all fields in the entity.
   284  //
   285  // Example:
   286  //
   287  //	var v []struct {
   288  //		CreatedAt uint32 `json:"created_at,omitempty"`
   289  //	}
   290  //
   291  //	client.CoinDescription.Query().
   292  //		Select(coindescription.FieldCreatedAt).
   293  //		Scan(ctx, &v)
   294  //
   295  func (cdq *CoinDescriptionQuery) Select(fields ...string) *CoinDescriptionSelect {
   296  	cdq.fields = append(cdq.fields, fields...)
   297  	selbuild := &CoinDescriptionSelect{CoinDescriptionQuery: cdq}
   298  	selbuild.label = coindescription.Label
   299  	selbuild.flds, selbuild.scan = &cdq.fields, selbuild.Scan
   300  	return selbuild
   301  }
   302  
   303  func (cdq *CoinDescriptionQuery) prepareQuery(ctx context.Context) error {
   304  	for _, f := range cdq.fields {
   305  		if !coindescription.ValidColumn(f) {
   306  			return &ValidationError{Name: f, err: fmt.Errorf("ent: invalid field %q for query", f)}
   307  		}
   308  	}
   309  	if cdq.path != nil {
   310  		prev, err := cdq.path(ctx)
   311  		if err != nil {
   312  			return err
   313  		}
   314  		cdq.sql = prev
   315  	}
   316  	if coindescription.Policy == nil {
   317  		return errors.New("ent: uninitialized coindescription.Policy (forgotten import ent/runtime?)")
   318  	}
   319  	if err := coindescription.Policy.EvalQuery(ctx, cdq); err != nil {
   320  		return err
   321  	}
   322  	return nil
   323  }
   324  
   325  func (cdq *CoinDescriptionQuery) sqlAll(ctx context.Context, hooks ...queryHook) ([]*CoinDescription, error) {
   326  	var (
   327  		nodes = []*CoinDescription{}
   328  		_spec = cdq.querySpec()
   329  	)
   330  	_spec.ScanValues = func(columns []string) ([]interface{}, error) {
   331  		return (*CoinDescription).scanValues(nil, columns)
   332  	}
   333  	_spec.Assign = func(columns []string, values []interface{}) error {
   334  		node := &CoinDescription{config: cdq.config}
   335  		nodes = append(nodes, node)
   336  		return node.assignValues(columns, values)
   337  	}
   338  	if len(cdq.modifiers) > 0 {
   339  		_spec.Modifiers = cdq.modifiers
   340  	}
   341  	for i := range hooks {
   342  		hooks[i](ctx, _spec)
   343  	}
   344  	if err := sqlgraph.QueryNodes(ctx, cdq.driver, _spec); err != nil {
   345  		return nil, err
   346  	}
   347  	if len(nodes) == 0 {
   348  		return nodes, nil
   349  	}
   350  	return nodes, nil
   351  }
   352  
   353  func (cdq *CoinDescriptionQuery) sqlCount(ctx context.Context) (int, error) {
   354  	_spec := cdq.querySpec()
   355  	if len(cdq.modifiers) > 0 {
   356  		_spec.Modifiers = cdq.modifiers
   357  	}
   358  	_spec.Node.Columns = cdq.fields
   359  	if len(cdq.fields) > 0 {
   360  		_spec.Unique = cdq.unique != nil && *cdq.unique
   361  	}
   362  	return sqlgraph.CountNodes(ctx, cdq.driver, _spec)
   363  }
   364  
   365  func (cdq *CoinDescriptionQuery) sqlExist(ctx context.Context) (bool, error) {
   366  	n, err := cdq.sqlCount(ctx)
   367  	if err != nil {
   368  		return false, fmt.Errorf("ent: check existence: %w", err)
   369  	}
   370  	return n > 0, nil
   371  }
   372  
   373  func (cdq *CoinDescriptionQuery) querySpec() *sqlgraph.QuerySpec {
   374  	_spec := &sqlgraph.QuerySpec{
   375  		Node: &sqlgraph.NodeSpec{
   376  			Table:   coindescription.Table,
   377  			Columns: coindescription.Columns,
   378  			ID: &sqlgraph.FieldSpec{
   379  				Type:   field.TypeUint32,
   380  				Column: coindescription.FieldID,
   381  			},
   382  		},
   383  		From:   cdq.sql,
   384  		Unique: true,
   385  	}
   386  	if unique := cdq.unique; unique != nil {
   387  		_spec.Unique = *unique
   388  	}
   389  	if fields := cdq.fields; len(fields) > 0 {
   390  		_spec.Node.Columns = make([]string, 0, len(fields))
   391  		_spec.Node.Columns = append(_spec.Node.Columns, coindescription.FieldID)
   392  		for i := range fields {
   393  			if fields[i] != coindescription.FieldID {
   394  				_spec.Node.Columns = append(_spec.Node.Columns, fields[i])
   395  			}
   396  		}
   397  	}
   398  	if ps := cdq.predicates; len(ps) > 0 {
   399  		_spec.Predicate = func(selector *sql.Selector) {
   400  			for i := range ps {
   401  				ps[i](selector)
   402  			}
   403  		}
   404  	}
   405  	if limit := cdq.limit; limit != nil {
   406  		_spec.Limit = *limit
   407  	}
   408  	if offset := cdq.offset; offset != nil {
   409  		_spec.Offset = *offset
   410  	}
   411  	if ps := cdq.order; len(ps) > 0 {
   412  		_spec.Order = func(selector *sql.Selector) {
   413  			for i := range ps {
   414  				ps[i](selector)
   415  			}
   416  		}
   417  	}
   418  	return _spec
   419  }
   420  
   421  func (cdq *CoinDescriptionQuery) sqlQuery(ctx context.Context) *sql.Selector {
   422  	builder := sql.Dialect(cdq.driver.Dialect())
   423  	t1 := builder.Table(coindescription.Table)
   424  	columns := cdq.fields
   425  	if len(columns) == 0 {
   426  		columns = coindescription.Columns
   427  	}
   428  	selector := builder.Select(t1.Columns(columns...)...).From(t1)
   429  	if cdq.sql != nil {
   430  		selector = cdq.sql
   431  		selector.Select(selector.Columns(columns...)...)
   432  	}
   433  	if cdq.unique != nil && *cdq.unique {
   434  		selector.Distinct()
   435  	}
   436  	for _, m := range cdq.modifiers {
   437  		m(selector)
   438  	}
   439  	for _, p := range cdq.predicates {
   440  		p(selector)
   441  	}
   442  	for _, p := range cdq.order {
   443  		p(selector)
   444  	}
   445  	if offset := cdq.offset; offset != nil {
   446  		// limit is mandatory for offset clause. We start
   447  		// with default value, and override it below if needed.
   448  		selector.Offset(*offset).Limit(math.MaxInt32)
   449  	}
   450  	if limit := cdq.limit; limit != nil {
   451  		selector.Limit(*limit)
   452  	}
   453  	return selector
   454  }
   455  
   456  // ForUpdate locks the selected rows against concurrent updates, and prevent them from being
   457  // updated, deleted or "selected ... for update" by other sessions, until the transaction is
   458  // either committed or rolled-back.
   459  func (cdq *CoinDescriptionQuery) ForUpdate(opts ...sql.LockOption) *CoinDescriptionQuery {
   460  	if cdq.driver.Dialect() == dialect.Postgres {
   461  		cdq.Unique(false)
   462  	}
   463  	cdq.modifiers = append(cdq.modifiers, func(s *sql.Selector) {
   464  		s.ForUpdate(opts...)
   465  	})
   466  	return cdq
   467  }
   468  
   469  // ForShare behaves similarly to ForUpdate, except that it acquires a shared mode lock
   470  // on any rows that are read. Other sessions can read the rows, but cannot modify them
   471  // until your transaction commits.
   472  func (cdq *CoinDescriptionQuery) ForShare(opts ...sql.LockOption) *CoinDescriptionQuery {
   473  	if cdq.driver.Dialect() == dialect.Postgres {
   474  		cdq.Unique(false)
   475  	}
   476  	cdq.modifiers = append(cdq.modifiers, func(s *sql.Selector) {
   477  		s.ForShare(opts...)
   478  	})
   479  	return cdq
   480  }
   481  
   482  // Modify adds a query modifier for attaching custom logic to queries.
   483  func (cdq *CoinDescriptionQuery) Modify(modifiers ...func(s *sql.Selector)) *CoinDescriptionSelect {
   484  	cdq.modifiers = append(cdq.modifiers, modifiers...)
   485  	return cdq.Select()
   486  }
   487  
   488  // CoinDescriptionGroupBy is the group-by builder for CoinDescription entities.
   489  type CoinDescriptionGroupBy struct {
   490  	config
   491  	selector
   492  	fields []string
   493  	fns    []AggregateFunc
   494  	// intermediate query (i.e. traversal path).
   495  	sql  *sql.Selector
   496  	path func(context.Context) (*sql.Selector, error)
   497  }
   498  
   499  // Aggregate adds the given aggregation functions to the group-by query.
   500  func (cdgb *CoinDescriptionGroupBy) Aggregate(fns ...AggregateFunc) *CoinDescriptionGroupBy {
   501  	cdgb.fns = append(cdgb.fns, fns...)
   502  	return cdgb
   503  }
   504  
   505  // Scan applies the group-by query and scans the result into the given value.
   506  func (cdgb *CoinDescriptionGroupBy) Scan(ctx context.Context, v interface{}) error {
   507  	query, err := cdgb.path(ctx)
   508  	if err != nil {
   509  		return err
   510  	}
   511  	cdgb.sql = query
   512  	return cdgb.sqlScan(ctx, v)
   513  }
   514  
   515  func (cdgb *CoinDescriptionGroupBy) sqlScan(ctx context.Context, v interface{}) error {
   516  	for _, f := range cdgb.fields {
   517  		if !coindescription.ValidColumn(f) {
   518  			return &ValidationError{Name: f, err: fmt.Errorf("invalid field %q for group-by", f)}
   519  		}
   520  	}
   521  	selector := cdgb.sqlQuery()
   522  	if err := selector.Err(); err != nil {
   523  		return err
   524  	}
   525  	rows := &sql.Rows{}
   526  	query, args := selector.Query()
   527  	if err := cdgb.driver.Query(ctx, query, args, rows); err != nil {
   528  		return err
   529  	}
   530  	defer rows.Close()
   531  	return sql.ScanSlice(rows, v)
   532  }
   533  
   534  func (cdgb *CoinDescriptionGroupBy) sqlQuery() *sql.Selector {
   535  	selector := cdgb.sql.Select()
   536  	aggregation := make([]string, 0, len(cdgb.fns))
   537  	for _, fn := range cdgb.fns {
   538  		aggregation = append(aggregation, fn(selector))
   539  	}
   540  	// If no columns were selected in a custom aggregation function, the default
   541  	// selection is the fields used for "group-by", and the aggregation functions.
   542  	if len(selector.SelectedColumns()) == 0 {
   543  		columns := make([]string, 0, len(cdgb.fields)+len(cdgb.fns))
   544  		for _, f := range cdgb.fields {
   545  			columns = append(columns, selector.C(f))
   546  		}
   547  		columns = append(columns, aggregation...)
   548  		selector.Select(columns...)
   549  	}
   550  	return selector.GroupBy(selector.Columns(cdgb.fields...)...)
   551  }
   552  
   553  // CoinDescriptionSelect is the builder for selecting fields of CoinDescription entities.
   554  type CoinDescriptionSelect struct {
   555  	*CoinDescriptionQuery
   556  	selector
   557  	// intermediate query (i.e. traversal path).
   558  	sql *sql.Selector
   559  }
   560  
   561  // Scan applies the selector query and scans the result into the given value.
   562  func (cds *CoinDescriptionSelect) Scan(ctx context.Context, v interface{}) error {
   563  	if err := cds.prepareQuery(ctx); err != nil {
   564  		return err
   565  	}
   566  	cds.sql = cds.CoinDescriptionQuery.sqlQuery(ctx)
   567  	return cds.sqlScan(ctx, v)
   568  }
   569  
   570  func (cds *CoinDescriptionSelect) sqlScan(ctx context.Context, v interface{}) error {
   571  	rows := &sql.Rows{}
   572  	query, args := cds.sql.Query()
   573  	if err := cds.driver.Query(ctx, query, args, rows); err != nil {
   574  		return err
   575  	}
   576  	defer rows.Close()
   577  	return sql.ScanSlice(rows, v)
   578  }
   579  
   580  // Modify adds a query modifier for attaching custom logic to queries.
   581  func (cds *CoinDescriptionSelect) Modify(modifiers ...func(s *sql.Selector)) *CoinDescriptionSelect {
   582  	cds.modifiers = append(cds.modifiers, modifiers...)
   583  	return cds
   584  }