Class BaseDbQuery

Base class that represents a query for the 'db' table.

ModelCriteria

cli_db\propel\om\BaseDbQuery

Direct known subclasses

Abstract
Namespace: cli_db\propel\om
Package: propel\generator\cli\db\om
Located at src/cli/db/propel-classes/cli_db/om/BaseDbQuery.php

Methods summary
`public`	# `__construct( string $dbName = 'cli_db', string $modelName = 'cli_db\\propel\\Db', string $modelAlias = null )` Initializes internal state of BaseDbQuery object. Initializes internal state of BaseDbQuery object. Parameters `$dbName` `string` $dbName The dabase name `$modelName` `string` $modelName The phpName of a model, e.g. 'Book' `$modelAlias` `string` $modelAlias The alias for the model in this query, e.g. 'b'
`public static cli_db\propel\DbQuery`	# `create( string $modelAlias = null, cli_db\propel\DbQuery\|Criteria $criteria = null )` Returns a new DbQuery object. Returns a new DbQuery object. Parameters `$modelAlias` `string` $modelAlias The alias of a model in the query `$criteria` `cli_db\propel\DbQuery\|Criteria` $criteria Optional Criteria to build the query from Returns `cli_db\propel\DbQuery`
`public cli_db\propel\Db\|cli_db\propel\Db[]\|mixed`	# `findPk( mixed $key, PropelPDO $con = null )` Find object by primary key. Propel uses the instance pool to skip the database if the object exists. Go fast if the query is untouched. Find object by primary key. Propel uses the instance pool to skip the database if the object exists. Go fast if the query is untouched. $obj = $c->findPk(12, $con); Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con an optional connection object Returns `cli_db\propel\Db\|cli_db\propel\Db[]\|mixed` the result, formatted by the current formatter
`public cli_db\propel\Db`	# `findOneByDbId( mixed $key, PropelPDO $con = null )` Alias of findPk to use instance pooling Alias of findPk to use instance pooling Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con A connection object Returns `cli_db\propel\Db` A model object, or null if the key is not found Throws `PropelException`
`protected cli_db\propel\Db`	# `findPkSimple( mixed $key, PropelPDO $con )` Find object by primary key using raw SQL to go fast. Bypass doSelect() and the object formatter by using generated code. Find object by primary key using raw SQL to go fast. Bypass doSelect() and the object formatter by using generated code. Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con A connection object Returns `cli_db\propel\Db` A model object, or null if the key is not found Throws `PropelException`
`protected cli_db\propel\Db\|cli_db\propel\Db[]\|mixed`	# `findPkComplex( mixed $key, PropelPDO $con )` Find object by primary key. Find object by primary key. Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con A connection object Returns `cli_db\propel\Db\|cli_db\propel\Db[]\|mixed` the result, formatted by the current formatter
`public PropelObjectCollection\|cli_db\propel\Db[]\|mixed`	# `findPks( array $keys, PropelPDO $con = null )` Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con); Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con); Parameters `$keys` `array` $keys Primary keys to use for the query `$con` `PropelPDO` $con an optional connection object Returns `PropelObjectCollection\|cli_db\propel\Db[]\|mixed` the list of results, formatted by the current formatter
`public cli_db\propel\DbQuery`	# `filterByPrimaryKey( mixed $key )` Filter the query by primary key Filter the query by primary key Parameters `$key` `mixed` $key Primary key to use for the query Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByPrimaryKeys( array $keys )` Filter the query by a list of primary keys Filter the query by a list of primary keys Parameters `$keys` `array` $keys The list of primary key to use for the query Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByDbId( mixed $dbId = null, string $comparison = null )` Filter the query on the db_id column Filter the query on the db_id column Example usage: $query->filterByDbId(1234); // WHERE db_id = 1234 $query->filterByDbId(array(12, 34)); // WHERE db_id IN (12, 34) $query->filterByDbId(array('min' => 12)); // WHERE db_id >= 12 $query->filterByDbId(array('max' => 12)); // WHERE db_id <= 12 Parameters `$dbId` `mixed` $dbId The value to use as filter. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByName( string $name = null, string $comparison = null )` Filter the query on the name column Filter the query on the name column Example usage: $query->filterByName('fooValue'); // WHERE name = 'fooValue' $query->filterByName('%fooValue%'); // WHERE name LIKE '%fooValue%' Parameters `$name` `string` $name The value to use as filter. Accepts wildcards (* and % trigger a LIKE) `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByDescription( string $description = null, string $comparison = null )` Filter the query on the description column Filter the query on the description column Example usage: $query->filterByDescription('fooValue'); // WHERE description = 'fooValue' $query->filterByDescription('%fooValue%'); // WHERE description LIKE '%fooValue%' Parameters `$description` `string` $description The value to use as filter. Accepts wildcards (* and % trigger a LIKE) `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByUrlprefix( string $urlprefix = null, string $comparison = null )` Filter the query on the urlprefix column Filter the query on the urlprefix column Example usage: $query->filterByUrlprefix('fooValue'); // WHERE urlprefix = 'fooValue' $query->filterByUrlprefix('%fooValue%'); // WHERE urlprefix LIKE '%fooValue%' Parameters `$urlprefix` `string` $urlprefix The value to use as filter. Accepts wildcards (* and % trigger a LIKE) `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByUrl( string $url = null, string $comparison = null )` Filter the query on the url column Filter the query on the url column Example usage: $query->filterByUrl('fooValue'); // WHERE url = 'fooValue' $query->filterByUrl('%fooValue%'); // WHERE url LIKE '%fooValue%' Parameters `$url` `string` $url The value to use as filter. Accepts wildcards (* and % trigger a LIKE) `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbQuery`	# `filterByDbxref( cli_db\propel\Dbxref\|PropelObjectCollection $dbxref, string $comparison = null )` Filter the query by a related Dbxref object Filter the query by a related Dbxref object Parameters `$dbxref` `cli_db\propel\Dbxref\|PropelObjectCollection` $dbxref the related object to use as filter `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\DbQuery` The current query, for fluid interface Throws `PropelException` - if the provided filter is invalid.
`public cli_db\propel\DbQuery`	# `joinDbxref( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )` Adds a JOIN clause to the query using the Dbxref relation Adds a JOIN clause to the query using the Dbxref relation Parameters `$relationAlias` `string` $relationAlias optional alias for the relation `$joinType` `string` $joinType Accepted values are null, 'left join', 'right join', 'inner join' Returns `cli_db\propel\DbQuery` The current query, for fluid interface
`public cli_db\propel\DbxrefQuery`	# `useDbxrefQuery( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )` Use the Dbxref relation Dbxref object Use the Dbxref relation Dbxref object Parameters `$relationAlias` `string` $relationAlias optional alias for the relation, to be used as main alias in the secondary query `$joinType` `string` $joinType Accepted values are null, 'left join', 'right join', 'inner join' Returns `cli_db\propel\DbxrefQuery` A secondary query class using the current class as primary query See useQuery()
`public cli_db\propel\DbQuery`	# `prune( cli_db\propel\Db $db = null )` Exclude object from result Exclude object from result Parameters `$db` `cli_db\propel\Db` $db Object to remove from the list of results Returns `cli_db\propel\DbQuery` The current query, for fluid interface

Magic methods summary
`public cli_db\propel\DbQuery`	# `orderByDbId( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the db_id column Order by the db_id column Parameters `$order` `mixed` $order Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `orderByName( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the name column Order by the name column Parameters `$order` `mixed` $order Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `orderByDescription( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the description column Order by the description column Parameters `$order` `mixed` $order Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `orderByUrlprefix( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the urlprefix column Order by the urlprefix column Parameters `$order` `mixed` $order Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `orderByUrl( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the url column Order by the url column Parameters `$order` `mixed` $order Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `groupByDbId( )` Group by the db_id column Group by the db_id column Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `groupByName( )` Group by the name column Group by the name column Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `groupByDescription( )` Group by the description column Group by the description column Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `groupByUrlprefix( )` Group by the urlprefix column Group by the urlprefix column Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `groupByUrl( )` Group by the url column Group by the url column Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `leftJoin( mixed $relation = )` Adds a LEFT JOIN clause to the query Adds a LEFT JOIN clause to the query Parameters `$relation` `mixed` $relation Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `rightJoin( mixed $relation = )` Adds a RIGHT JOIN clause to the query Adds a RIGHT JOIN clause to the query Parameters `$relation` `mixed` $relation Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `innerJoin( mixed $relation = )` Adds a INNER JOIN clause to the query Adds a INNER JOIN clause to the query Parameters `$relation` `mixed` $relation Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `leftJoinDbxref( mixed $relationAlias = null )` Adds a LEFT JOIN clause to the query using the Dbxref relation Adds a LEFT JOIN clause to the query using the Dbxref relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `rightJoinDbxref( mixed $relationAlias = null )` Adds a RIGHT JOIN clause to the query using the Dbxref relation Adds a RIGHT JOIN clause to the query using the Dbxref relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\DbQuery`
`public cli_db\propel\DbQuery`	# `innerJoinDbxref( mixed $relationAlias = null )` Adds a INNER JOIN clause to the query using the Dbxref relation Adds a INNER JOIN clause to the query using the Dbxref relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\DbQuery`
`public cli_db\propel\Db`	# `findOne( PropelPDO $con = null )` Return the first Db matching the query Return the first Db matching the query Parameters `$con` `PropelPDO` $con Returns `cli_db\propel\Db`
`public cli_db\propel\Db`	# `findOneOrCreate( PropelPDO $con = null )` Return the first Db matching the query, or a new Db object populated from the query conditions when no match is found Return the first Db matching the query, or a new Db object populated from the query conditions when no match is found Parameters `$con` `PropelPDO` $con Returns `cli_db\propel\Db`
`public cli_db\propel\Db`	# `findOneByName( string $name = )` Return the first Db filtered by the name column Return the first Db filtered by the name column Parameters `$name` `string` $name Returns `cli_db\propel\Db`
`public cli_db\propel\Db`	# `findOneByDescription( string $description = )` Return the first Db filtered by the description column Return the first Db filtered by the description column Parameters `$description` `string` $description Returns `cli_db\propel\Db`
`public cli_db\propel\Db`	# `findOneByUrlprefix( string $urlprefix = )` Return the first Db filtered by the urlprefix column Return the first Db filtered by the urlprefix column Parameters `$urlprefix` `string` $urlprefix Returns `cli_db\propel\Db`
`public cli_db\propel\Db`	# `findOneByUrl( string $url = )` Return the first Db filtered by the url column Return the first Db filtered by the url column Parameters `$url` `string` $url Returns `cli_db\propel\Db`
`public array`	# `findByDbId( integer $db_id = )` Return Db objects filtered by the db_id column Return Db objects filtered by the db_id column Parameters `$db_id` `integer` $db_id Returns `array`
`public array`	# `findByName( string $name = )` Return Db objects filtered by the name column Return Db objects filtered by the name column Parameters `$name` `string` $name Returns `array`
`public array`	# `findByDescription( string $description = )` Return Db objects filtered by the description column Return Db objects filtered by the description column Parameters `$description` `string` $description Returns `array`
`public array`	# `findByUrlprefix( string $urlprefix = )` Return Db objects filtered by the urlprefix column Return Db objects filtered by the urlprefix column Parameters `$urlprefix` `string` $urlprefix Returns `array`
`public array`	# `findByUrl( string $url = )` Return Db objects filtered by the url column Return Db objects filtered by the url column Parameters `$url` `string` $url Returns `array`

Namespaces

Classes

Class BaseDbQuery

Direct known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns