Difference between revisions of "Hashing Module"
Jump to navigation
Jump to search
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | All functions in this module are assigned to the <code><nowiki>http://basex.org/modules/hash</nowiki></code> namespace, which is statically bound to the {{Code|hash}} prefix.<br/> | + | {{Mark|Updated with Version 9.0}}: |
− | + | ||
+ | All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/hash</nowiki></code> namespace, which is statically bound to the {{Code|hash}} prefix.<br/> | ||
=Functions= | =Functions= | ||
Line 63: | Line 64: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|algorithm|#Errors}} the specified hashing algorithm is unknown. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
Line 72: | Line 73: | ||
=Errors= | =Errors= | ||
+ | |||
+ | {{Mark|Updated with Version 9.0}}: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
Line 77: | Line 80: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|algorithm}} |
|The specified hash algorithm is unknown. | |The specified hash algorithm is unknown. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.0 | ||
+ | |||
+ | * Updated: error codes updates; errors now use the module namespace | ||
The module was introduced with Version 7.3. | The module was introduced with Version 7.3. |
Revision as of 13:27, 21 November 2017
This XQuery Module provides functions that perform different hash operations.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/hash
namespace, which is statically bound to the hash
prefix.
Functions
hash:md5
Signatures | hash:md5($value as xs:anyAtomicType) as xs:base64Binary |
Summary | Computes the MD5 hash of the given $value , which may be of type xs:string, xs:base64Binary, or xs:hexBinary.
|
Examples |
|
hash:sha1
Signatures | hash:sha1($value as xs:anyAtomicType) as xs:base64Binary |
Summary | Computes the SHA-1 hash of the given $value , which may be of type xs:string, xs:base64Binary, or xs:hexBinary.
|
Examples |
|
hash:sha256
Signatures | hash:sha256($value as xs:anyAtomicType) as xs:base64Binary |
Summary | Computes the SHA-256 hash of the given $value , which may be of type xs:string, xs:base64Binary, or xs:hexBinary.
|
Examples |
|
hash:hash
Signatures | hash:hash($value as xs:anyAtomicType, $algorithm as xs:string) as xs:base64Binary |
Summary | Computes the hash of the given $value , using the specified $algorithm . The specified values may be of type xs:string, xs:base64Binary, or xs:hexBinary.The following three algorihms are supported: MD5 , SHA-1 , and SHA-256 .
|
Errors | algorithm : the specified hashing algorithm is unknown.
|
Examples |
|
Errors
Code | Description |
---|---|
algorithm
|
The specified hash algorithm is unknown. |
Changelog
- Version 9.0
- Updated: error codes updates; errors now use the module namespace
The module was introduced with Version 7.3.