Sun Microsystems 5800 manual

Sun StorageTek 5800 System

Client API Reference Manual

SunMicrosystems, Inc.

4150Network Circle

SantaClara, CA 95054

U.S.A.

PartNo:820–4796

June2008

Contents

Main Page Contents Page Page Page Page Page Page Page Preface HowThis Book Is Organized RelatedB ooks RelatedThird-Party Web Site References Documentation, Support, andTraining TypographicConventions Shell Promptsin Command Examples SunWelcomes Your Comments Page Sun StorageTek5800 System Client API Changes inVersion 1.1 5800 SystemOverview 5800 SystemSummary The5800 System and Honeycomb The5800 System Data Model Page The5800 System Metadata Model The5800 System Query Model The5800 System Query Integrity Model Deleting Objects from the 5800 System Page Page Sun StorageTek5800 System Java Client API Overview of the 5800 SystemJava Client API Client Library Interfaces Retrying Operations Performanceand Sc alability UpdatingClient View of the Schema JavaClient Application Deployment JavaAPI JavaAPI Packages JavaAPI Documentation Basic Concepts KeyClasses NameValueObjectArchive NameValueSchema ObjectIdentifier QueryResultSet SystemRecord NameValueObjectArchive Application Access NameValueObjectArchive delete storeObject storeMetadata checkIndexed retrieveObject retrieveMetadata getSchema query query(with selectKeys) query(with PreparedStatement) query(with PreparedStatement and selectKeys) PreparedStatement QueryResultSet getObjectIdentifier isQueryComplete getQueryIntegrityTime QueryIntegrityTime Sun StorageTek5800 System C Client API Overview of the 5800 SystemC Client API Architecture Interfaces Retrying Operations MultithreadedAccess Performanceand Sc alability Memory Usage UpdatingS chema Denitions Session Management HeapMemory Allocator HeapMemory Deallocator Terminatinga Global Session SystemRecord Failureand Recovery C Client Application Deployment Nonblocking C API SynchronousC API Changes forthe 1.1 Release Limitations SynchronousC Data Types hc_string_t hc_long_t hc_double_t Typefor holding oating-point values. hc_type_t 5800system name-value metadata type specier. Speciesone of the 5800 system metadata types that can go in the archive. hc_value_t 5800system name-value metadata data value. hc_schema_t hc_nvr_t hc_session_t hc_pstmt_t hc_query_result_set_t read_from_data_source write_to_data_destination hcerr_t Page SynchronousC API Functions Managing 5800 SystemSessions hc_session_create_ez Page hc_session_free hc_session_get_status hc_session_get_schema hc_session_get_host hc_session_get_platform_result hc_session_get_archive Managing a Schema hc_schema_get_type hc_schema_get_length hc_schema_get_count hc_schema_get_type_at_index ManipulatingName -ValueRecords Usingthe API for Storing Name -ValueRecords ToUse the API for Storing Name-ValueRecords UsingReturned Name -ValueRecords ToUse Returned Name-ValueRecords Creatingand Freeing Name-Value Records hc_nvr_create hc_nvr_free Parameter Building Name-ValueRecords hc_nvr_add_value hc_nvr_add_long hc_nvr_add_double hc_nvr_add_string hc_nvr_add_binary hc_nvr_add_date hc_nvr_add_time hc_nvr_add_timestamp hc_nvr_add_from_string RetrievingName -ValueRecords hc_nvr_get_count hc_nvr_get_value_at_index hc_nvr_get_long hc_nvr_get_double hc_nvr_get_string hc_nvr_get_binary hc_nvr_get_date hc_nvr_get_time hc_nvr_get_timestamp Creatingand Converting Name-Value Records From andTo String Arrays hc_nvr_create_from_string_arrays Page hc_nvr_convert_to_string_arrays StoringData and Metadata hc_store_both_ez hc_store_metadata_ez hc_check_indexed_ez Page RetrievingData and Metadata hc_retrieve_ez hc_retrieve_metadata_ez hc_range_retrieve_ez Querying Metadata hc_query_ez Page hc_qrs_next_ez hc_qrs_is_query_complete hc_qrs_get_query_integrity_time Parameter hc_qrs_free hc_pstmt_create hc_pstmt_free hc_pstmt_set_string hc_pstmt_set_char hc_pstmt_set_double hc_pstmt_set_long hc_pstmt_set_date hc_pstmt_set_time hc_pstmt_set_timestamp hc_pstmt_set_binary hc_pstmt_query_ez hc_pstmt_createon page 100 Querying Witha Prepared Statement Deleting Records Thefollowing function is dened to delete records: hc_delete_ez on page 111. hc_delete_ez Deletesthe metadata record for specied OID. TranslatingError and Type Codes hc_decode_hcerr hc_decode_hc_type Page Sun StorageTek5800 System Query Language Interfaces Operation Supported Data Types Queries Translatinga Query to the Underlying Database AttributeFormat in Queries SQL Syntaxin 5800 System Queries LiteralsIn Q ueries Dynamic Parameters String Literals Numeric Literals Literalsfor 5800 System Data Types Canonical String Format TheCanonical String Decode Operation JDBC and HADB Dateand Time Operations ReservedWords Supported Expression Types Page Examples of Supported Query Expressions Queries Not Supported in Version1.1 SQLWords That Are Allowed in Queries SQLWords That Are Not Allowed in Queries Page Page Programming Considerationsand Best Practices Retries and Timeouts Query Size Limit Limit the Size of Schema Query Parameters and Literals Limit Results PerFetch Index Numbersand Symbols B C D E F G H I N O P Q R S