Sun StorageTek 5800 System Client API Reference Manual


Numbers and Symbols

	5800 system
		Honeycomb project ( )
		summary ( )


B

	best practices
		max results per fetch ( )
		retries and timeouts ( )
		schema query size ( )


C

	canonical string
		decode operation ( )
		format ( )

	C client API
		application deployment ( )
		architecture ( )
		failure and recovery ( )
		`hc_cleanup` ( )
		`hc_init` ( )
		`hc_system_record_t` ( )
		heap memory
			allocator ( )
			deallocator ( )
			rellocator ( )
		interfaces ( )
		memory usage ( )
		multithreaded access ( )
		nonblocking ( )
		performance and scalability ( )
		session management ( ) ( )
		synchronous ( )
		system record ( )
		updating schema definitions ( )

	C client library ( )

	changes for this release ( )

	`checkIndexed` method ( )

	creating, prepared statement ( )


D

	data
		retrieve for OID
			`hc_retrieve_ez` ( )
		retrieve range of data for OID
			`hc_range_retrieve_ez` ( )
		retrieving ( )
		storing ( )
			`hc_store_both_ez` ( )

	data model, overview ( )

	data type
		synchronous C API ( )
			`hcerr_t` ( )
			`hc_long_t` ( )
			`hc_nvr_t` ( )
			`hc_pstmt_t` ( )
			`hc_query_result_set_t` ( )
			`hc_session_t` ( )
			`hc_string_t` ( )
			`hc_value_t` ( )
			`read_from_data_source` ( )
			`write_to_data_destination` ( )

	deleting, objects, overview ( )


E

	error codes
		list of ( )
		translating into a string
			`hc_decode_hcerr` ( )


F

	fetches, limiting max results ( )


G

	`getObjectIdentifier` method ( )

	`getQueryIntegrityTime` method ( )

	`getSchema` method ( )


H

	HADB Date and Time operations ( )

	`hc_cleanup` ( )

	`hc_init` ( )

	`hc_system_record_t` ( )

	heap memory
		allocator ( )
		deallocator ( )
		reallocator ( )

	Honeycomb project, overview ( )


I

	`isQueryComplete` method ( )


J

	Java client API
		application deployment ( )
		basic concepts ( )
		classes ( ) ( )
			`NameValueObjectArchive` ( ) ( )
			`NameValueRecord` ( )
			`NameValueSchema` ( )
			`ObjectIdentifier` ( )
			`QueryResultSet` ( )
			`SystemRecord` ( )
		interfaces ( )
		Javadoc tool ( )
		packages ( )
		performance and scalability ( )

	Java client library ( )

	Javadoc tool ( )

	JDBC Date and Time operations ( )


L

	limitations, synchronous C API ( )

	literals
		numeric ( )
		string ( )


M

	metadata ( )
		add metadata record for OID
			`hc_store_both_ez` ( )
		check if present for OID
			`hc_check_indexed_ez` ( )
		deleting ( )
		querying ( )
			`hc_pstmt_create` ( )
			`hc_pstmt_free` ( )
			`hc_pstmt_query_ez` ( )
			`hc_pstmt_set_date` ( )
			`hc_qrs_free` ( )
			`hc_qrs_next_ez` ( )
		retrieve for OID
			`hc_retrieve_metadata_ez` ( )
		retrieving ( )
		storing ( )
			`hc_store_both_ez` ( ) ( )

	metadata model, overview ( )

	models
		data ( )
		deleting objects ( )
		metadata ( )
		query ( )
		query integrity ( )

	multithreaded access ( )


N

	`NameValueObjectArchive` class ( ) ( )
		`checkIndexed` method ( )
		`getObjectIdentifier` method ( )
		`getQueryIntegrityTime` method ( )
		`getSchema` method ( )
		`isQueryComplete` method ( )
		`NameValueObjectArchive` constructor ( )
		`query` method ( ) ( ) ( ) ( )
		`QueryResultSet` method ( )
		`retrieveMetadata` method ( )
		`retrieveObject` method ( )
		`storeMetadata` method ( )
		`storeObject` method ( )

	`NameValueObjectArchive` constructor ( )

	`NameValueRecord` class ( )

	name-value records ( )
		building ( )
			`hc_nvr_add_binary` ( )
			`hc_nvr_add_date` ( )
			`hc_nvr_add_double` ( )
			`hc_nvr_add_from_string` ( )
			`hc_nvr_add_long` ( )
			`hc_nvr_add_string` ( )
			`hc_nvr_add_time` ( )
			`hc_nvr_add_timestamp` ( )
			`hc_nvr_add_value` ( )
		converting to string arrays ( )
		creating
			`hc_nvr_create` ( )
		creating and freeing ( )
		creating from string arrays ( )
			`hc_nvr_convert_to_string_arrays` ( )
			`hc_nvr_create_from_string_arrays` ( )
		manipulating ( )
		retrieve OID and record
			`hc_pstmt_query_ez` ( )
		retrieving ( )
			`hc_nvr_get_binary` ( )
			`hc_nvr_get_count` ( )
			`hc_nvr_get_date` ( )
			`hc_nvr_get_double` ( )
			`hc_nvr_get_long` ( )
			`hc_nvr_get_string` ( )
			`hc_nvr_get_time` ( )
			`hc_nvr_get_timestamp` ( )
			`hc_nvr_get_value_at_index` ( )
		storing ( )
		using returned ( )

	`NameValueSchema` class ( )

	nonblocking C API ( )


O

	Object Identifier, See OID

	`ObjectIdentifier` class ( )

	objects, deleting, overview ( )

	OID
		add metadata record
			`hc_store_metadata_ez` ( )
		check if metadata is present
			`hc_check_indexed_ez` ( )
		deleting metadata ( )
		fetch next
			`hc_qrs_next_ez` ( )
		overview ( )
		retrieve and optionally name
			`hc_query_ez` ( )
		retrieve data for OID
			`hc_retrieve_ez` ( )
		retrieve metadata for
			`hc_retrieve_metadata_ez` ( )
		retrieve, optionally retrieve name-value record
			`hc_pstmt_query_ez` ( )
		retrieve range of data for
			`hc_range_retrieve_ez` ( )

	operations
		retrying ( ) ( )

	overview ( )
		5800 system ( )
		data model ( )
		Honeycomb project ( )
		metadata model ( )
		query integrity model ( )
		query model ( )


P

	prepared statement
		add binary binding to
			`hc_pstmt_set_binary` ( )
		add char binding to
			`hc_pstmt_set_char` ( )
		add date binding to
			`hc_pstmt_set_date` ( )
		add double precision binding to
			`hc_pstmt_set_double` ( )
		add `hc_long_t` binding to
			`hc_pstmt_set_long` ( )
		add string binding to
			`hc_pstmt_set_string` ( )
		add time-of-day binding to
			`hc_pstmt_set_time` ( )
		add timestamp binding to
			`hc_pstmt_set_timestamp` ( )
		creating ( )
		freeing
			`hc_pstmt_free` ( )
		querying example ( )
		retrieve OIDs, optionally retrieve name-value record
			`hc_pstmt_query_ez` ( )


Q

	queries ( )
		best practices ( )
		determine if complete
			`hc_qrs_is_query_complete` ( )
		determine query integrity time
			`hc_qrs_get_query_integrity_time` ( )
		dynamic parameters ( ) ( )
		fetch next OID
			`hc_qrs_next_ez` ( )
		integrity model overview ( )
		literal format ( )
		literals ( )
		literals size ( )
		max results per fetch ( )
		model overview ( )
		numeric literals ( )
		parameters size ( )
		prepared statement query example ( )
		query with prepared statement
			`hc_query_ez` ( )
		release query set results
			`hc_qrs_free` ( )
		string literals ( )
		syntax ( )

	query language
		allowed words in queries ( )
		attribute format ( )
		dynamic parameters ( )
		examples ( )
		expression types ( )
		features not supported ( )
		forbidden words in queries ( )
		interfaces ( )
		literal format ( )
		literals in queries ( )
		operation ( )
		queries ( )
		reserved words ( )
		syntax in queries ( )

	`query` method ( ) ( ) ( ) ( )

	`QueryResultSet` class ( )

	`QueryResultSet` method ( )

	`query` size limit ( )


R

	retries ( )

	`retrieveMetadata` method ( )

	`retrieveObject` method ( )

	retrying operations ( ) ( )


S

	schema
		managing ( )
			`hc_schema_get_count` ( )
			`hc_schema_get_length` ( )
			`hc_schema_get_type` ( )
			`hc_schema_get_type_at_index` ( )

	schema definitions, updating ( )

	session management
		`allocator_t` ( )
		`deallocator_t` ( )
		failure and recovery ( )
		`hc_cleanup` ( )
		`hc_init` ( )
		`hc_system_record_t` ( )
		`reallocator_t` ( )

	sessions
		C client API
			`hc_session_create_ez` ( )
			`hc_session_free` ( )
			`hc_session_get_archive` ( )
			`hc_session_get_host` ( )
			`hc_session_get_platform_result` ( )
			`hc_session_get_schema` ( )
			`hc_session_get_status` ( )
			initializing ( )
			managing ( )
			terminating ( )

	StorageTek 5800, Query Language ( )

	`storeMetadata` method ( )

	`storeObject` method ( )

	string decode operation, canonical ( )

	string format, canonical ( )

	Sun StorageTek 5800, Query Language ( )

	Sun StorageTek 5800 system
		semantics
			data and metadata ( )
			`query` size limit ( )

	synchronous C API ( )
		add binary binding to prepared statement
			`hc_pstmt_set_binary` ( )
		add char binding to prepared statement
			`hc_pstmt_set_char` ( )
		add date binding to prepared statement
			`hc_pstmt_set_date` ( )
		add double precision binding to prepared statement
			`hc_pstmt_set_double` ( )
		add `hc_long_t` binding to prepared statement
			`hc_pstmt_set_long` ( )
		add metadata record for OID
			`hc_store_metadata_ez` ( )
		add string binding to prepared statement
			`hc_pstmt_set_string` ( )
		add time-of-day binding to prepared statement
			`hc_pstmt_set_time` ( )
		add timestamp binding to prepared statement
			`hc_pstmt_set_timestamp` ( )
		check if OID metadata is present
			`hc_check_indexed_ez` ( )
		create prepared statement
			`hc_pstmt_create` ( )
		data types ( )
			`hc_double_t` ( )
			`hcerr_t` ( )
			`hc_long_t` ( )
			`hc_nvr_t` ( )
			`hc_pstmt_t` ( )
			`hc_query_result_set_t` ( )
			`hc_schema_t` ( )
			`hc_session_t` ( )
			`hc_string_t` ( )
			`hc_type_t` ( )
			`hc_value_t` ( )
			`read_from_data_source` ( )
			`write_to_data_destination` ( )
		determine if query complete
			`hc_qrs_is_query_complete` ( )
		determine query integrity time
			`hc_qrs_get_query_integrity_time` ( )
		error code list ( )
		error codes
			translating into a string ( )
		fetch next OID
			`hc_qrs_next_ez` ( )
		free prepared statement
			`hc_pstmt_free` ( )
		functions ( )
			`hc_nvr_get_count` ( )
			`hc_pstmt_create` ( ) ( )
			`hc_pstmt_free` ( ) ( )
			`hc_pstmt_query_ez` ( )
			`hc_pstmt_set_binary` ( )
			`hc_pstmt_set_char` ( )
			`hc_pstmt_set_date` ( ) ( )
			`hc_pstmt_set_double` ( )
			`hc_pstmt_set_long` ( )
			`hc_pstmt_set_string` ( )
			`hc_pstmt_set_time` ( )
			`hc_pstmt_set_timestamp` ( )
			`hc_qrs_free` ( ) ( )
			`hc_qrs_get_query_integrity_time` ( )
			`hc_qrs_is_query_complete` ( )
			`hc_qrs_next_ez` ( )
			`hc_query_ez` ( )
			`hc_session_create_ez` ( )
			`hc_session_free` ( )
			`hc_session_get_archive` ( )
			`hc_session_get_host` ( )
			`hc_session_get_platform_result` ( )
			`hc_session_get_schema` ( )
			`hc_session_get_status` ( )
			`hc_store_both_ez` ( )
		limitations ( )
		managing schema
			`hc_schema_get_count` ( )
			`hc_schema_get_length` ( )
			`hc_schema_get_type` ( )
			`hc_schema_get_type_at_index` ( )
		name-value records ( )
			building ( )
			creating and converting ( )
			creating and freeing ( )
			`hc_nvr_add_binary` ( )
			`hc_nvr_add_date` ( )
			`hc_nvr_add_double` ( )
			`hc_nvr_add_from_string` ( )
			`hc_nvr_add_long` ( )
			`hc_nvr_add_string` ( )
			`hc_nvr_add_time` ( )
			`hc_nvr_add_timestamp` ( )
			`hc_nvr_add_value` ( )
			`hc_nvr_convert_to_string_arrays` ( )
			`hc_nvr_create` ( )
			`hc_nvr_create_from_string_arrays` ( )
			`hc_nvr_get_binary` ( )
			`hc_nvr_get_count` ( )
			`hc_nvr_get_date` ( )
			`hc_nvr_get_double` ( )
			`hc_nvr_get_long` ( )
			`hc_nvr_get_string` ( )
			`hc_nvr_get_time` ( )
			`hc_nvr_get_timestamp` ( )
			`hc_nvr_get_value_at_index` ( )
			storing ( )
			storing data and metadata ( )
			using returned ( )
		OID
			deleting ( )
		prepared statement
			`querying example` ( )
		query with prepared statement
			`hc_query_ez` ( )
		release query set results
			`hc_qrs_free` ( )
		retrieve data for OID
			`hc_retrieve_ez` ( )
		retrieve metadata for OID
			`hc_retrieve_metadata_ez` ( )
		retrieve OIDs, optionally retrieve name-value record
			`hc_pstmt_query_ez` ( )
		retrieve range of data for OID
			`hc_range_retrieve_ez` ( )
		storing data and metadata
			`hc_store_both_ez` ( )

	`SystemRecord` class ( )


T

	timeouts ( )