Difference between revisions of "SUMVALUES()"

From Recital Documentation Wiki
Jump to: navigation, search
(SUMVALUES())
(See Also)
 
(3 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
 
==Syntax==
 
==Syntax==
SUMVALUES(<expN> [, <for condition> [, <key expression>]])
+
SUMVALUES(<expN> [[, <for condition> [, <key expression>]] [,<tag name or indexorder>] )
 
+
  
 
==See Also==
 
==See Also==
[[AVERAGE]], [[COUNT]], [[SUM]], [[TOTAL]], [[AMAX()]], [[AMIN()]], [[AVGVALUES()]], [[CNTVALUES()]], [[MAX()]], [[MAXVALUES()]], [[MIN()]], [[MINVALUES()]], [[SQLVALUES()]]
+
[[AVERAGE]], [[COUNT]], [[SUM]], [[TOTAL]], [[AMAX()]], [[AMIN()]], [[AVGVALUES()]], [[CNTVALUES()]], [[MAX()]], [[MAXVALUES()]], [[MIN()]], [[MINVALUES()]], [[SQLVALUES()]], [[ALLVALUES()]]
 
+
  
 
==Description==
 
==Description==
The SUMVALUES() function returns the total value of <expN> for a matching series of keys.  The required <expN> parameter must be a column name from a table.  If none of the optional parameters is specified, then the number of keys matching the current key is returned.  An optional <for condition> can be specified to restrict the rows included in the sum operation.  You can also optionally specify a <key expression> to perform the sum on instead of the current key.
+
The SUMVALUES() function returns the total value of <expN> for a matching series of keys.  The required <expN> parameter should be a numeric expression referencing columna from the current workarea (or cursor).  If none of the optional parameters is specified, then the keys matching the current key is scanned.  An optional <for condition> can be specified to restrict the rows included in the sum operation.  You can also optionally specify a <key expression> to perform the sum on instead of the current key. An optional <tag name or index order> can be specified also.
  
 
After completion, all record pointers and indexes are returned to their original positions.
 
After completion, all record pointers and indexes are returned to their original positions.
 
  
 
==Example==
 
==Example==
Line 30: Line 27:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Latest revision as of 04:41, 20 June 2010

Purpose

Function to returns the total value of a column for a matching series of keys


Syntax

SUMVALUES(<expN> [[, <for condition> [, <key expression>]] [,<tag name or indexorder>] )

See Also

AVERAGE, COUNT, SUM, TOTAL, AMAX(), AMIN(), AVGVALUES(), CNTVALUES(), MAX(), MAXVALUES(), MIN(), MINVALUES(), SQLVALUES(), ALLVALUES()

Description

The SUMVALUES() function returns the total value of <expN> for a matching series of keys. The required <expN> parameter should be a numeric expression referencing columna from the current workarea (or cursor). If none of the optional parameters is specified, then the keys matching the current key is scanned. An optional <for condition> can be specified to restrict the rows included in the sum operation. You can also optionally specify a <key expression> to perform the sum on instead of the current key. An optional <tag name or index order> can be specified also.

After completion, all record pointers and indexes are returned to their original positions.

Example

use customer order title 
// Sum the balance column for the number of records matching the current key
total_balance = sumvalues(balance) 
// Sum the balance column for the number of records matching the key "Mr"
m_male = sumvalues(balance, .T., "Mr")
//Sum the balance column for the number of records matching the current key with an expiry date < today
m_expired = sumvalues(balance, expiry < date())


Products

Recital, Recital Server