Home
The Toolkit for Online Communities
15939 Community Members, 0 members online, 2422 visitors today
Log In Register

::xo::db::CrClass instproc instance_select_query

OpenACS Home : ACS API Browser : {::xo::db::CrClass instproc instance_select_query}

::xo::db::CrClass instproc instance_select_query (public)

<instance of ::xo::db::CrClass[i]> instance_select_query \
    [ -select_attributes select_attributes ] [ -orderby orderby ] \
    [ -where_clause where_clause ] [ -from_clause from_clause ] \
    [ -with_subtypes on|off ] [ -with_children on|off ] \
    [ -publish_status publish_status ] [ -count on|off ] \
    [ -folder_id folder_id ] [ -parent_id parent_id ] \
    [ -page_size page_size ] [ -page_number page_number ] \
    [ -base_table base_table ]
Defined in packages/xotcl-core/tcl/cr-procs.tcl

returns the SQL-query to select the CrItems of the specified object_type

Switches:
-select_attributes (optional)
-orderby (optional)
for ordering the solution set
-where_clause (optional)
clause for restricting the answer set
-from_clause (optional)
-with_subtypes (boolean) (defaults to "true") (optional)
return subtypes as well
-with_children (boolean) (defaults to "false") (optional)
return immediate child objects of all objects as well
-publish_status (optional)
one of 'live', 'ready', or 'production'
-count (boolean) (defaults to "false") (optional)
return the query for counting the solutions
-folder_id (optional)
parent_id
-parent_id (optional)
-page_size (defaults to "20") (optional)
-page_number (optional)
-base_table (defaults to "cr_revisions") (optional)
typically automatic view, must contain title and revision_id
Returns:
sql query
[ show source ]
Show another procedure: