mySobek Home   |   Help
Skip Navigation Links.
MISSING BANNER

Engine_Database Class



Database gateway for the engine library, used for all database calls


Namespace: SobekCM.Engine_Library.Database
Assembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
public static class Engine_Database

Inheritance Hierarchy

System..::..Object
  SobekCM.Engine_Library.Database..::..Engine_Database

Methods

  NameDescription
Public methodStatic memberAggregate_Statistics
Aggregate all the item-level and item group-level hits up the hierarchy to the aggregations
Public methodStatic memberBuilder_Delete_Incoming_Folder
Deletes an existing builder incoming folder from the table
Public methodStatic memberBuilder_Edit_Incoming_Folder
Edits an existing builder incoming folder or adds a new folder
Public methodStatic memberBuilder_Get_Folder_Module_Sets
Gets the most recent updates for the builder including the builder settings and scheduled tasks
Public methodStatic memberBuilder_Get_Incoming_Folder
Gets the latest information about a builder source folder, by primary key
Public methodStatic memberBuilder_Get_Recent_Updates
Gets the most recent updates for the builder including the builder settings and scheduled tasks
Public methodStatic memberBuilder_Log_Search
Gets the matching builder logs, including a possible restriction by date range or bibid/vid
Public methodStatic memberDelete_Thematic_Heading
Deletes a thematic heading from the database
Public methodStatic memberEdit_Thematic_Heading
Saves a new thematic heading or updates an existing thematic heading
Public methodStatic memberGet_Aggregation_Hierarchies
Method used to get the hierarchical relationship between all aggregationPermissions, to be displayed in the 'aggregationPermissions' tab in the internal screen
Public methodStatic memberGet_All_Browse_Paged(Boolean, Boolean, Int32, Int32, Int32, Boolean, List<(Of <<'(Int16>)>>), Boolean, Custom_Tracer)
Gets the collection of all (public) items in the library
Public methodStatic memberGet_All_Browse_Paged(String, Boolean, Int32, Int32, Int32, Boolean, List<(Of <<'(Int16>)>>), Boolean, Custom_Tracer)
Gets the collection of all (public) items in the library
Public methodStatic memberGet_All_Coordinate_Points_By_Aggregation
Gets the list of unique coordinate points and associated bibid and group title for a single item aggregation
Public methodStatic memberGet_All_Template_DefaultMetadatas
Gets the dataset with all default metadata and all templates
Public methodStatic memberGet_All_User_Groups
Gets the list of all user groups
Public methodStatic memberGet_All_Web_Skins
Datatable with the information for every html skin from the database
Public methodStatic memberGet_Builder_Settings
Gets the list of modules and incoming folders for the builder
Public methodStatic memberGet_IP_Restriction_Ranges
Gets the list of all the IP ranges for restriction, including each single IP information in those ranges
Public methodStatic memberGet_Item_Aggregation
Gets the database information about a single item aggregation
Public methodStatic memberGet_Item_Aggregation_Browse_Paged(String, Boolean, Boolean, Int32, Int32, Int32, Boolean, List<(Of <<'(Int16>)>>), Boolean, Custom_Tracer)
Gets the collection of all (public) items linked to an item aggregation
Public methodStatic memberGet_Item_Aggregation_Browse_Paged(String, String, Boolean, Int32, Int32, Int32, Boolean, List<(Of <<'(Int16>)>>), Boolean, Custom_Tracer)
Gets the collection of all (public) items linked to an item aggregation
Public methodStatic memberGet_Item_Aggregation_Counts
Adds the title, item, and page counts to this item aggregation object
Public methodStatic memberGet_Item_Aggregation_Metadata_Browse
Gets the list of all data for a particular metadata field in a particular aggregation
Public methodStatic memberGet_Item_Details
Gets some basic information about an item before displaying it, such as the descriptive notes from the database, ability to add notes, etc..
Public methodStatic memberGet_Item_Group_Details
Gets some basic information about an item group before displaying it, such as the descriptive notes from the database, ability to add notes, etc..
Public methodStatic memberGet_Item_Information(String, String, Custom_Tracer)
Gets complete information for an item which may be missing from the complete list of items
Public methodStatic memberGet_Item_Information(String, String, Boolean, Custom_Tracer)
Gets complete information for an item which may be missing from the complete list of items
Public methodStatic memberGet_Items_By_Coordinates
Performs geographic search for items within provided rectangular bounding box and linked to item aggregation of interest
Public methodStatic memberGet_Main_Aggregation
Gets the database information about the main aggregation, representing the entire web page
Public methodStatic memberGet_Public_Folder_Browse
Get a browse of all items in a user's public folder
Public methodStatic memberGet_Random_Item
Gets a random item from the database
Public methodStatic memberGet_Settings_Complete
Gets all the setting information necessary for SobekCM
Public methodStatic memberGet_Statistics_Lookup_Tables
Gets all the tables ued during the process of reading the statistics from the web iis logs and creating the associated commands
Public methodStatic memberGet_User(Int32, Custom_Tracer)
Gets basic user information by UserID
Public methodStatic memberGet_User(String, Custom_Tracer)
Gets basic user information by the Shibboleth-provided user identifier
Public methodStatic memberGet_User(String, String, Custom_Tracer)
Gets basic user information by Username (or email) and Password
Public methodStatic memberGet_User_Folder_Browse
Get a browse of all items in a user's folder
Public methodStatic memberGet_User_Linked_Items_Stats
Gets the basic usage statistics for all items linked to a user
Public methodStatic memberGet_Users_Linked_To_Items
Gets the list of all users that are linked to items which may have usage statistics
Public methodStatic memberGet_Viewer_Priority
Get the list of viewer priority set at the instance level
Public methodStatic memberItems_By_ALEPH_Number
Returns the list of all items/titles which match a given ALEPH number
Public methodStatic memberItems_By_OCLC_Number
Returns the list of all items/titles which match a given OCLC number
Public methodStatic memberLog_Sent_Email
Log the fact an email was sent via a different system than the databse mail
Public methodStatic memberPerform_Metadata_Exact_Search_Paged
Performs a metadata search for a piece of metadata that EXACTLY matches the provided search term and return one page of results
Public methodStatic memberPerform_Metadata_Search_Paged(String, Boolean, String, Int64, Int64, Int32, Int32, Int32, Boolean, List<(Of <<'(Int16>)>>), Boolean, Custom_Tracer)
Performs a basic metadata search over the entire citation, given a search condition, and returns one page of results
Public methodStatic memberPerform_Metadata_Search_Paged(Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Int32, String, Int32, Boolean, String, Int64, Int64, Int32, Int32, Int32, Boolean, List<(Of <<'(Int16>)>>), Boolean, Custom_Tracer)
Perform a metadata search against items in the database and return one page of results
Public methodStatic memberPopulate_Aggregation_Aliases
Populates the lookup tables for aliases which point to live aggregationPermissions
Public methodStatic memberPopulate_Code_Manager
Populates the code manager object for translating SobekCM codes to greenstone collection codes
Public methodStatic memberPopulate_Icon_List
Populates the dictionary of all icons from the database
Public methodStatic memberPopulate_Item_Lookup_Object
Populates the item lookup object with all the valid bibids and vids in the system
Public methodStatic memberPopulate_MIME_List
Populates the dictionary of all files and MIME types from the database
Public methodStatic memberPopulate_Statistics_Dates
Populates the date range from the database for which statistical information exists
Public methodStatic memberPopulate_Thematic_Headings
Populates the collection of the thematic headings for the main home page
Public methodStatic memberPopulate_Translations
Populates the translation / language support object for translating common UI terms
Public methodStatic memberPopulate_URL_Portals
Populates the collection of possible portals from the database
Public methodStatic memberSave_Aggregation_Statistics
Save usage statistics for the aggregation-level web pages
Public methodStatic memberSave_Item_Aggregation(String, String, String, String, Int32, String, Boolean, Boolean, String, Int32, String, String, Custom_Tracer)
Save a new item aggregation with the basic details provided in the new aggregation form
Public methodStatic memberSave_Item_Aggregation(Int32, String, String, String, String, Thematic_Heading, String, Boolean, Boolean, String, Int32, Int32, Int32, Int32, Boolean, String, String, String, String, Int32, String, String, Custom_Tracer)
Save a new item aggregation or edit an existing item aggregation in the database
Public methodStatic memberSave_Item_Group_Statistics
Save usage statistics at the item level (BibID) level
Public methodStatic memberSave_Item_Statistics
Save the item-level usage statistics
Public methodStatic memberSave_Portal_Statistics
Save the usage statistics for a single URL portal
Public methodStatic memberSave_TopLevel_Statistics
Save the top-level usage statistics for this instance for a single month
Public methodStatic memberSave_WebContent_Statistics
Save usage statistics for top-level web content pages
Public methodStatic memberSearch_Stop_Words
Gets the list of all search stop words which are ignored during searching ( such as 'The', 'A', etc.. )
Public methodStatic memberSend_Database_Email
Send an email using database mail through the database
Public methodStatic memberSimple_Item_List
Gets the simple list of items for a single item aggregation, or the list of all items in the library
Public methodStatic memberTest_Connection()()()()
Test connectivity to the database
Public methodStatic memberTest_Connection(String)
Test connectivity to the database
Public methodStatic memberTracking_Online_Edit_Complete
Marks an item as been editing online through the web interface
Protected methodStatic memberVerify_Item_Lookup_Object
Verified the item lookup object is filled, or populates the item lookup object with all the valid bibids and vids in the system
Public methodStatic memberWebContent_Add_Milestone
Add a new milestone to an existing web content page
Public methodStatic memberWebContent_Add_Page
Add a new web content page
Public methodStatic memberWebContent_Delete_Page
Delete an existing web content page (and mark in the milestones)
Public methodStatic memberWebContent_Edit_Page
Edit an existing web content page
Public methodStatic memberWebContent_Get_All
Gets the dataset of all global content pages AND redirects
Public methodStatic memberWebContent_Get_All_Pages
Gets the dataset of all global content pages (excluding redirects)
Public methodStatic memberWebContent_Get_All_Redirects
Gets the dataset of all global redirects
Public methodStatic memberWebContent_Get_Milestones
Get the milestones / history for a single web content page
Public methodStatic memberWebContent_Get_Page(Int32, Custom_Tracer)
Gets the basic information about a web content page, by primary key
Public methodStatic memberWebContent_Get_Page(String, String, String, String, String, String, String, String, Custom_Tracer)
Gets the basic information about a web content page, by the URL segments
Public methodStatic memberWebContent_Get_Recent_Changes
Get the global milestones of all changes to all top-level static html pages
Public methodStatic memberWebContent_Get_Usage
Get the usage statistics for a single web content page
Public methodStatic memberWebContent_Get_Usage_Report
Gets the usage report for all top-level web content pages between two dates
Public methodStatic memberWebContent_Has_Usage
Flag indicates if there is usage logged for web content pages within the system
Public methodStatic memberWebContent_Populate_All_Hierarchy
Gets the hierarchy of all global content pages AND redirects, used for looking for a match from a requested URL

Properties

  NameDescription
Public propertyStatic memberConnection_String
Connection string to the main SobekCM databaase
Public propertyStatic memberDatabaseType
Gets the type of database ( i.e. MSSQL v. PostgreSQL )
Public propertyStatic memberLast_Exception
Gets the last exception caught by a database call through this gateway class

See Also



Version 4.10.0 ( last generated Monday, March 7, 2016 )