Set aside hibernate cache docs until the corresponding code is mainstreamed.
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/84cfbdfc Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/84cfbdfc Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/84cfbdfc Branch: refs/heads/feature/GEODE-1968 Commit: 84cfbdfc1013206d817a42a0f296f2df47c05a78 Parents: 6bea820 Author: Dave Barnes <dbar...@pivotal.io> Authored: Thu Oct 6 10:42:34 2016 -0700 Committer: Dave Barnes <dbar...@pivotal.io> Committed: Thu Oct 6 10:42:34 2016 -0700 ---------------------------------------------------------------------- geode-docs/.gitignore | 6 - geode-docs/CONTRIBUTE.md | 63 - geode-docs/README.md | 93 - geode-docs/about_geode.html.md.erb | 26 - geode-docs/basic_config/book_intro.html.md.erb | 40 - .../chapter_overview.html.md.erb | 40 - ...uted_system_member_configuration.html.md.erb | 51 - .../config_concepts/local_vs_remote.html.md.erb | 29 - .../chapter_overview.html.md.erb | 32 - .../managing_data_entries.html.md.erb | 146 - .../using_custom_classes.html.md.erb | 51 - .../data_regions/chapter_overview.html.md.erb | 65 - .../create_a_region_with_API.html.md.erb | 80 - .../create_a_region_with_cacheXML.html.md.erb | 85 - .../create_a_region_with_gfsh.html.md.erb | 55 - .../creating_custom_attributes.html.md.erb | 64 - .../managing_data_regions.html.md.erb | 222 -- .../managing_region_attributes.html.md.erb | 113 - .../new_region_existing_data.html.md.erb | 28 - .../data_regions/region_naming.html.md.erb | 31 - .../data_regions/region_shortcuts.html.md.erb | 115 - .../store_retrieve_region_shortcuts.html.md.erb | 77 - .../setting_distributed_properties.html.md.erb | 81 - .../the_cache/chapter_overview.html.md.erb | 48 - .../intro_cache_management.html.md.erb | 96 - .../managing_a_client_cache.html.md.erb | 84 - .../managing_a_multiuser_cache.html.md.erb | 66 - .../managing_a_peer_server_cache.html.md.erb | 81 - .../managing_a_secure_cache.html.md.erb | 67 - .../setting_cache_initializer.html.md.erb | 76 - .../setting_cache_properties.html.md.erb | 39 - .../configuring/chapter_overview.html.md.erb | 84 - .../deploying_application_jars.html.md.erb | 131 - .../cluster_config/export-import.html.md.erb | 56 - .../gfsh_config_troubleshooting.html.md.erb | 75 - .../gfsh_load_from_shared_dir.html.md.erb | 44 - .../cluster_config/gfsh_persist.html.md.erb | 125 - .../cluster_config/gfsh_remote.html.md.erb | 78 - .../persisting_configurations.html.md.erb | 337 -- .../using_member_groups.html.md.erb | 44 - .../running/change_file_spec.html.md.erb | 57 - .../running/default_file_specs.html.md.erb | 76 - .../deploy_config_files_intro.html.md.erb | 34 - .../running/deploying_config_files.html.md.erb | 45 - .../deploying_config_jar_files.html.md.erb | 52 - .../running/firewall_ports_config.html.md.erb | 32 - .../running/firewalls_connections.html.md.erb | 35 - .../running/firewalls_multisite.html.md.erb | 87 - .../running/firewalls_ports.html.md.erb | 246 -- .../running/managing_output_files.html.md.erb | 33 - .../running/running_the_cacheserver.html.md.erb | 199 - .../running/running_the_locator.html.md.erb | 257 -- .../starting_up_shutting_down.html.md.erb | 146 - geode-docs/developing/book_intro.html.md.erb | 74 - .../chapter_overview.html.md.erb | 38 - .../continuous_querying_whats_next.html.md.erb | 88 - .../how_continuous_querying_works.html.md.erb | 98 - ...implementing_continuous_querying.html.md.erb | 202 -- .../PDX_Serialization_Features.html.md.erb | 40 - .../auto_serialization.html.md.erb | 141 - ...ation_with_class_pattern_strings.html.md.erb | 85 - .../chapter_overview.html.md.erb | 40 - .../data_serialization_options.html.md.erb | 68 - .../extending_the_autoserializer.html.md.erb | 123 - .../gemfire_data_serialization.html.md.erb | 52 - .../gemfire_pdx_serialization.html.md.erb | 64 - .../java_serialization.html.md.erb | 29 - .../jsonformatter_pdxinstances.html.md.erb | 46 - .../persist_pdx_metadata_to_disk.html.md.erb | 53 - .../program_application_for_pdx.html.md.erb | 107 - .../use_pdx_high_level_steps.html.md.erb | 49 - .../use_pdx_serializable.html.md.erb | 115 - .../use_pdx_serializer.html.md.erb | 145 - .../using_PdxInstanceFactory.html.md.erb | 51 - .../using_pdx_region_entry_keys.html.md.erb | 31 - .../chapter_overview.html.md.erb | 48 - .../delta_propagation_example.html.md.erb | 130 - .../delta_propagation_properties.html.md.erb | 96 - .../errors_in_delta_propagation.html.md.erb | 35 - .../how_delta_propagation_works.html.md.erb | 69 - .../implementing_delta_propagation.html.md.erb | 41 - .../when_to_use_delta_prop.html.md.erb | 34 - .../chapter_overview.html.md.erb | 44 - .../choosing_level_of_dist.html.md.erb | 36 - .../how_distribution_works.html.md.erb | 48 - .../how_region_versioning_works.html.md.erb | 127 - .../how_region_versioning_works_wan.html.md.erb | 42 - .../how_replication_works.html.md.erb | 51 - .../locking_in_global_regions.html.md.erb | 109 - .../managing_distributed_regions.html.md.erb | 64 - .../region_entry_versions.html.md.erb | 51 - .../cache_event_handler_examples.html.md.erb | 155 - .../events/chapter_overview.html.md.erb | 44 - ...re_client_server_event_messaging.html.md.erb | 81 - ...figure_multisite_event_messaging.html.md.erb | 39 - .../configure_p2p_event_messaging.html.md.erb | 50 - ...uring_gateway_concurrency_levels.html.md.erb | 158 - ..._highly_available_gateway_queues.html.md.erb | 119 - ...iguring_highly_available_servers.html.md.erb | 55 - ...conflate_multisite_gateway_queue.html.md.erb | 130 - ...nflate_server_subscription_queue.html.md.erb | 53 - .../events/event_handler_overview.html.md.erb | 40 - .../filtering_multisite_events.html.md.erb | 126 - .../ha_event_messaging_whats_next.html.md.erb | 95 - .../events/how_cache_events_work.html.md.erb | 71 - ...client_server_distribution_works.html.md.erb | 137 - .../events/how_events_work.html.md.erb | 111 - ...how_multisite_distribution_works.html.md.erb | 68 - ...mplementing_cache_event_handlers.html.md.erb | 153 - ..._durable_client_server_messaging.html.md.erb | 199 - ...nting_write_behind_event_handler.html.md.erb | 245 -- ...t_server_subscription_queue_size.html.md.erb | 74 - ...ist_of_event_handlers_and_events.html.md.erb | 181 - .../resolving_multisite_conflicts.html.md.erb | 80 - ..._client_message_tracking_timeout.html.md.erb | 43 - ...ne_client_server_event_messaging.html.md.erb | 37 - ..._callbacks_that_modify_the_cache.html.md.erb | 65 - .../eviction/chapter_overview.html.md.erb | 34 - .../configuring_data_eviction.html.md.erb | 88 - .../eviction/how_eviction_works.html.md.erb | 36 - .../expiration/chapter_overview.html.md.erb | 32 - .../configuring_data_expiration.html.md.erb | 83 - .../expiration/how_expiration_works.html.md.erb | 70 - .../function_exec/chapter_overview.html.md.erb | 36 - .../function_execution.html.md.erb | 254 -- .../how_function_execution_works.html.md.erb | 131 - .../chapter_overview.html.md.erb | 40 - .../chapter_overview.html.md.erb | 34 - .../how_data_loaders_work.html.md.erb | 52 - .../implementing_data_loaders.html.md.erb | 88 - .../sync_outside_data.html.md.erb | 36 - .../chapter_overview.html.md.erb | 60 - .../checking_region_redundancy.html.md.erb | 55 - ...locating_partitioned_region_data.html.md.erb | 128 - .../configure_pr_single_hop.html.md.erb | 39 - .../configuring_bucket_for_pr.html.md.erb | 70 - .../configuring_ha_for_pr.html.md.erb | 58 - ...partitioning_and_data_colocation.html.md.erb | 58 - .../how_partitioning_works.html.md.erb | 58 - .../how_pr_ha_works.html.md.erb | 61 - .../how_pr_single_hop_works.html.md.erb | 48 - .../join_query_partitioned_regions.html.md.erb | 97 - .../managing_partitioned_regions.html.md.erb | 42 - .../moving_partitioned_data.html.md.erb | 76 - ...partitioning_and_data_colocation.html.md.erb | 36 - .../overview_how_pr_ha_works.html.md.erb | 32 - ...overview_how_pr_single_hop_works.html.md.erb | 32 - .../rebalancing_pr_data.html.md.erb | 106 - .../set_crash_redundancy_recovery.html.md.erb | 60 - .../set_enforce_unique_host.html.md.erb | 34 - .../set_join_redundancy_recovery.html.md.erb | 66 - .../set_pr_redundancy.html.md.erb | 51 - .../set_redundancy_zones.html.md.erb | 40 - ...using_custom_partition_resolvers.html.md.erb | 221 -- .../advanced_querying.html.md.erb | 48 - .../case_sensitivity.html.md.erb | 36 - .../query_additional/literals.html.md.erb | 82 - .../query_additional/operators.html.md.erb | 57 - .../order_by_on_partitioned_regions.html.md.erb | 35 - ...tioned_region_key_or_field_value.html.md.erb | 83 - ...tioned_region_query_restrictions.html.md.erb | 50 - .../query_debugging.html.md.erb | 104 - .../query_language_features.html.md.erb | 41 - .../query_on_a_single_node.html.md.erb | 172 - .../supported_keywords.html.md.erb | 48 - .../using_query_bind_parameters.html.md.erb | 65 - .../create_multiple_indexes.html.md.erb | 78 - .../query_index/creating_an_index.html.md.erb | 111 - .../creating_hash_indexes.html.md.erb | 68 - .../creating_key_indexes.html.md.erb | 66 - .../creating_map_indexes.html.md.erb | 61 - .../query_index/index_samples.html.md.erb | 80 - ...indexes_on_single_region_queries.html.md.erb | 50 - .../indexes_with_overflow_regions.html.md.erb | 58 - .../query_index/indexing_guidelines.html.md.erb | 41 - .../query_index/maintaining_indexes.html.md.erb | 69 - .../query_index/query_index.html.md.erb | 79 - .../query_index/query_index_hints.html.md.erb | 40 - ...ng_indexes_with_equijoin_queries.html.md.erb | 69 - ...quijoin_queries_multiple_regions.html.md.erb | 79 - .../query_select/aggregates.html.md.erb | 109 - .../query_select/the_from_clause.html.md.erb | 103 - .../the_import_statement.html.md.erb | 31 - .../the_select_statement.html.md.erb | 220 -- .../query_select/the_where_clause.html.md.erb | 353 -- .../chapter_overview.html.md.erb | 38 - .../comments_in_query_strings.html.md.erb | 30 - .../monitor_queries_for_low_memory.html.md.erb | 41 - .../oql_compared_to_sql.html.md.erb | 31 - .../performance_considerations.html.md.erb | 33 - .../querying_basics/query_basics.html.md.erb | 57 - ...query_grammar_and_reserved_words.html.md.erb | 163 - .../querying_partitioned_regions.html.md.erb | 41 - .../querying_basics/reserved_words.html.md.erb | 129 - ...ictions_and_unsupported_features.html.md.erb | 35 - .../querying_basics/running_a_query.html.md.erb | 87 - .../supported_character_sets.html.md.erb | 24 - .../what_is_a_query_string.html.md.erb | 50 - .../region_options/chapter_overview.html.md.erb | 40 - .../data_hosts_and_accessors.html.md.erb | 31 - .../dynamic_region_creation.html.md.erb | 197 - .../region_options/region_types.html.md.erb | 146 - .../storage_distribution_options.html.md.erb | 40 - .../chapter_overview.html.md.erb | 41 - .../how_persist_overflow_work.html.md.erb | 64 - .../overflow_config_examples.html.md.erb | 53 - .../storing_data_on_disk.html.md.erb | 79 - .../transactions/JTA_transactions.html.md.erb | 243 -- .../transactions/about_transactions.html.md.erb | 47 - .../cache_plugins_with_jta.html.md.erb | 28 - .../cache_transaction_performance.html.md.erb | 29 - .../transactions/cache_transactions.html.md.erb | 51 - ...ache_transactions_by_region_type.html.md.erb | 156 - .../transactions/chapter_overview.html.md.erb | 48 - .../client_server_transactions.html.md.erb | 55 - ...guring_db_connections_using_JNDI.html.md.erb | 330 -- ...data_location_cache_transactions.html.md.erb | 32 - .../how_cache_transactions_work.html.md.erb | 73 - .../jca_adapter_example.html.md.erb | 51 - ...onitor_troubleshoot_transactions.html.md.erb | 56 - .../run_a_cache_transaction.html.md.erb | 90 - ...che_transaction_with_external_db.html.md.erb | 54 - .../transaction_coding_examples.html.md.erb | 44 - .../transaction_event_management.html.md.erb | 56 - .../transaction_jta_gemfire_example.html.md.erb | 48 - .../transaction_semantics.html.md.erb | 54 - ...ansaction_suspend_resume_example.html.md.erb | 38 - ...ctional_and_nontransactional_ops.html.md.erb | 117 - .../transactional_function_example.html.md.erb | 72 - .../transactions_overview.html.md.erb | 67 - .../transactions/turning_off_jta.html.md.erb | 40 - .../working_with_transactions.html.md.erb | 229 -- .../15_minute_quickstart_gfsh.html.md.erb | 516 --- .../getting_started/book_intro.html.md.erb | 40 - .../getting_started/geode_overview.html.md.erb | 37 - .../installation/install_standalone.html.md.erb | 138 - .../getting_started/product_intro.html.md.erb | 101 - .../querying_quick_reference.html.md.erb | 711 ---- .../getting_started/setup_classpath.html.md.erb | 122 - .../host_machine.html.md.erb | 49 - .../uninstall_gemfire.html.md.erb | 26 - .../images/ClientServerAdvancedTopics-5.gif | Bin 10798 -> 0 bytes .../images/ClientServerAdvancedTopics-6.gif | Bin 12056 -> 0 bytes .../images/ClientServerAdvancedTopics-7.gif | Bin 5000 -> 0 bytes geode-docs/images/ContinuousQuerying-1.gif | Bin 6955 -> 0 bytes geode-docs/images/ContinuousQuerying-3.gif | Bin 9141 -> 0 bytes geode-docs/images/DataManagement-9.png | Bin 48188 -> 0 bytes geode-docs/images/DeltaPropagation-1.gif | Bin 7593 -> 0 bytes geode-docs/images/DeltaPropagation-3.gif | Bin 6843 -> 0 bytes geode-docs/images/Events-2.gif | Bin 8793 -> 0 bytes geode-docs/images/Events-3.gif | Bin 6432 -> 0 bytes geode-docs/images/FuncExecOnMembers.png | Bin 64959 -> 0 bytes .../images/FuncExecOnRegionHAWithFilter.png | Bin 80141 -> 0 bytes .../images/FuncExecOnRegionNoMetadata.png | Bin 70177 -> 0 bytes .../images/FuncExecOnRegionPeersWithFilter.png | Bin 86576 -> 0 bytes .../images/FuncExecOnRegionWithFilter.png | Bin 60773 -> 0 bytes .../images/FuncExecOnRegionWithMetadata.png | Bin 59576 -> 0 bytes geode-docs/images/FuncExecOnServers.png | Bin 57470 -> 0 bytes geode-docs/images/Gemcached.png | Bin 87366 -> 0 bytes geode-docs/images/JConsole.png | Bin 64272 -> 0 bytes geode-docs/images/MultiSite-4.gif | Bin 4991 -> 0 bytes .../images/MultisiteConcurrency_WAN_Gateway.png | Bin 103701 -> 0 bytes geode-docs/images/SQLite_Persistence_Mgr.png | Bin 58388 -> 0 bytes geode-docs/images/Transaction-simple.png | Bin 119831 -> 0 bytes geode-docs/images/consistent_multisite.png | Bin 39442 -> 0 bytes geode-docs/images/diskStores-1.gif | Bin 7292 -> 0 bytes geode-docs/images/diskStores-3.gif | Bin 5898 -> 0 bytes geode-docs/images/jconsole_mbeans.png | Bin 211394 -> 0 bytes geode-docs/images/jvisualvm.png | Bin 90153 -> 0 bytes geode-docs/images/logging-1.gif | Bin 2778 -> 0 bytes geode-docs/images/member_view_list.png | Bin 107811 -> 0 bytes .../images/multisite-topology-avoid-3.png | Bin 9794 -> 0 bytes .../images/multisite-topology-hybrid-1.png | Bin 7627 -> 0 bytes .../images/multisite-topology-hybrid-2.png | Bin 7631 -> 0 bytes .../images/multisite-topology-parallel.png | Bin 7838 -> 0 bytes geode-docs/images/multisite-topology-serial.png | Bin 6886 -> 0 bytes geode-docs/images/parallel_sender.png | Bin 36089 -> 0 bytes geode-docs/images/pulse-data-browser.png | Bin 99987 -> 0 bytes geode-docs/images/pulse-region-detail.png | Bin 61149 -> 0 bytes geode-docs/images/pulse_alerts_widget.png | Bin 137883 -> 0 bytes geode-docs/images/pulse_cluster_view.png | Bin 154531 -> 0 bytes geode-docs/images/pulse_data_view.png | Bin 138140 -> 0 bytes geode-docs/images/pulse_locator.png | Bin 228513 -> 0 bytes geode-docs/images/pulse_member_view.png | Bin 132309 -> 0 bytes .../images/rest_example_java_packages.png | Bin 30206 -> 0 bytes geode-docs/images/security-1.gif | Bin 8343 -> 0 bytes geode-docs/images/security-3.gif | Bin 8287 -> 0 bytes geode-docs/images/security-4.gif | Bin 7028 -> 0 bytes geode-docs/images/security-5.gif | Bin 7408 -> 0 bytes geode-docs/images/serial_sender.png | Bin 32385 -> 0 bytes geode-docs/images/statistics-1.gif | Bin 8644 -> 0 bytes geode-docs/images/swagger_home.png | Bin 187378 -> 0 bytes geode-docs/images/swagger_post_region.png | Bin 170963 -> 0 bytes .../images/swagger_post_region_response.png | Bin 176783 -> 0 bytes geode-docs/images/swagger_v1.png | Bin 149806 -> 0 bytes geode-docs/images/swagger_v1_response.png | Bin 143134 -> 0 bytes geode-docs/images/transactions-client-1.png | Bin 113816 -> 0 bytes geode-docs/images/transactions_jca_adapter.png | Bin 104775 -> 0 bytes geode-docs/images/transactions_jta.png | Bin 104780 -> 0 bytes .../images/transactions_jta_app_server.png | Bin 91885 -> 0 bytes geode-docs/images_svg/JMX_Architecture.svg | 3 - geode-docs/images_svg/MBeans.svg | 3 - .../async_system_queue_conflation.svg | 3 - geode-docs/images_svg/cache_data_loader.svg | 3 - geode-docs/images_svg/cache_data_loader_2.svg | 3 - .../images_svg/client_server_deployment.svg | 3 - .../images_svg/client_server_event_dist.svg | 3 - .../client_server_message_tracking.svg | 3 - geode-docs/images_svg/cluster-group-config.svg | 3 - .../images_svg/cluster_config_overview.svg | 3 - .../colocated_partitioned_regions.svg | 3 - geode-docs/images_svg/cs_connection_pool.svg | 3 - geode-docs/images_svg/cs_locator_discovery.svg | 3 - geode-docs/images_svg/cs_subscriptions.svg | 3 - geode-docs/images_svg/cs_topology.svg | 3 - geode-docs/images_svg/custom_partitioned.svg | 3 - geode-docs/images_svg/developing_overflow.svg | 3 - .../images_svg/developing_persistence.svg | 3 - .../developing_persistence_and_overflow.svg | 3 - geode-docs/images_svg/distributed_how_1.svg | 3 - geode-docs/images_svg/distributed_how_2.svg | 3 - geode-docs/images_svg/distributed_how_3.svg | 3 - geode-docs/images_svg/distributed_preload.svg | 3 - geode-docs/images_svg/distributed_replica.svg | 3 - .../images_svg/distributed_replica_preload.svg | 3 - geode-docs/images_svg/expiration.svg | 3 - .../images_svg/how_partitioning_works_1.svg | 3 - .../images_svg/how_partitioning_works_2.svg | 3 - .../images_svg/http_module_cs_with_locator.svg | 3 - .../images_svg/http_module_p2p_with_locator.svg | 3 - geode-docs/images_svg/locator_discovery.svg | 3 - geode-docs/images_svg/member_severe_alert.svg | 3 - .../images_svg/network_partition_scenario.svg | 3 - geode-docs/images_svg/p2p_topology.svg | 3 - geode-docs/images_svg/partitioned_data_HA.svg | 3 - .../images_svg/partitioned_data_buckets_1.svg | 3 - .../images_svg/partitioned_data_buckets_2.svg | 3 - .../images_svg/region_entry_versions_1.svg | 3 - .../images_svg/region_entry_versions_2.svg | 3 - .../images_svg/region_entry_versions_3.svg | 3 - .../images_svg/server_client_event_dist.svg | 3 - geode-docs/images_svg/server_discovery.svg | 3 - geode-docs/images_svg/server_grouping.svg | 3 - .../images_svg/transactions_partitioned_1.svg | 3 - .../images_svg/transactions_partitioned_2.svg | 3 - .../images_svg/transactions_replicate_1.svg | 3 - .../images_svg/transactions_replicate_2.svg | 3 - .../images_svg/transactions_replicate_3.svg | 3 - .../images_svg/transactions_replicate_4.svg | 3 - .../transactions_replicate_local_1.svg | 3 - .../transactions_replicate_no_ack_1.svg | 3 - .../transactions_replicate_no_ack_2.svg | 3 - .../images_svg/tune_cs_event_messaging.svg | 3 - .../unbalanced_network_capacity_probs.svg | 3 - .../autoreconnect/member-reconnect.html.md.erb | 59 - geode-docs/managing/book_intro.html.md.erb | 69 - .../chapter_overview.html.md.erb | 51 - .../exporting_a_snapshot.html.md.erb | 74 - .../filtering_snapshot_entries.html.md.erb | 46 - .../importing_a_snapshot.html.md.erb | 81 - .../read_snapshots_programmatically.html.md.erb | 43 - ...using_cache_and_region_snapshots.html.md.erb | 40 - .../backup_restore_disk_store.html.md.erb | 189 - .../disk_storage/chapter_overview.html.md.erb | 56 - .../compacting_disk_stores.html.md.erb | 133 - .../disk_free_space_monitoring.html.md.erb | 57 - .../disk_store_configuration_params.html.md.erb | 123 - .../file_names_and_extensions.html.md.erb | 96 - .../handling_missing_disk_stores.html.md.erb | 72 - .../how_disk_stores_work.html.md.erb | 60 - ...eping_offline_disk_store_in_sync.html.md.erb | 65 - .../managing_disk_buffer_flushes.html.md.erb | 44 - .../managing_disk_stores.html.md.erb | 42 - .../managing_disk_stores_cmds.html.md.erb | 62 - .../disk_storage/operation_logs.html.md.erb | 69 - ...ize_availability_and_performance.html.md.erb | 32 - .../overview_using_disk_stores.html.md.erb | 36 - ...starting_system_with_disk_stores.html.md.erb | 128 - .../disk_storage/using_disk_stores.html.md.erb | 216 -- .../using_the_default_disk_store.html.md.erb | 70 - .../validating_disk_store.html.md.erb | 37 - .../heap_use/heap_management.html.md.erb | 225 -- .../managing/heap_use/lock_memory.html.md.erb | 52 - .../heap_use/off_heap_management.html.md.erb | 209 -- .../logging/configuring_log4j2.html.md.erb | 68 - .../logging/how_logging_works.html.md.erb | 39 - .../logging/log_collection_utility.html.md.erb | 71 - geode-docs/managing/logging/logging.html.md.erb | 48 - .../logging/logging_categories.html.md.erb | 247 -- .../logging/logging_whats_next.html.md.erb | 56 - .../logging/setting_up_logging.html.md.erb | 76 - .../configuring_rmi_connector.html.md.erb | 34 - .../gfsh_and_management_api.html.md.erb | 69 - .../management/jmx_manager_node.html.md.erb | 37 - .../jmx_manager_operations.html.md.erb | 212 -- .../list_of_mbean_notifications.html.md.erb | 82 - .../management/list_of_mbeans.html.md.erb | 38 - .../management/list_of_mbeans_full.html.md.erb | 227 -- .../management_and_monitoring.html.md.erb | 52 - ...nagement_and_monitoring_features.html.md.erb | 41 - .../management_system_overview.html.md.erb | 112 - .../management/mbean_architecture.html.md.erb | 76 - .../management/mbean_notifications.html.md.erb | 34 - .../management/mbeans_jconsole.html.md.erb | 53 - .../managing/management/mm_overview.html.md.erb | 94 - ...tification_federation_and_alerts.html.md.erb | 54 - .../management/programming_example.html.md.erb | 237 -- .../monitor_tune/cache_consistency.html.md.erb | 80 - .../monitor_tune/chapter_overview.html.md.erb | 60 - .../gemfire_performance_on_vsphere.html.md.erb | 64 - ...erformance_on_vsphere_guidelines.html.md.erb | 136 - .../multicast_communication.html.md.erb | 46 - ...ication_configuring_speed_limits.html.md.erb | 51 - ...unication_provisioning_bandwidth.html.md.erb | 60 - ...unication_runtime_considerations.html.md.erb | 47 - ...n_testing_multicast_speed_limits.html.md.erb | 145 - ...st_communication_troubleshooting.html.md.erb | 38 - .../performance_controls.html.md.erb | 46 - ..._controls_controlling_socket_use.html.md.erb | 51 - ...ance_controls_data_serialization.html.md.erb | 26 - ...e_controls_increasing_cache_hits.html.md.erb | 28 - ...controls_managing_slow_receivers.html.md.erb | 73 - ..._controls_setting_cache_timeouts.html.md.erb | 41 - .../monitor_tune/slow_messages.html.md.erb | 38 - .../monitor_tune/slow_receivers.html.md.erb | 34 - .../slow_receivers_managing.html.md.erb | 116 - ...ow_receivers_preventing_problems.html.md.erb | 45 - .../socket_communication.html.md.erb | 48 - ...cation_ephemeral_tcp_port_limits.html.md.erb | 58 - ...ommunication_have_enough_sockets.html.md.erb | 185 - ...tion_setting_socket_buffer_sizes.html.md.erb | 144 - ...ion_tcpip_p2p_handshake_timeouts.html.md.erb | 38 - .../socket_tcp_keepalive.html.md.erb | 31 - .../sockets_and_gateways.html.md.erb | 122 - .../system_member_performance.html.md.erb | 42 - ...mance_connection_thread_settings.html.md.erb | 32 - ...rmance_distributed_system_member.html.md.erb | 28 - ...ystem_member_performance_garbage.html.md.erb | 53 - ...ber_performance_jvm_mem_settings.html.md.erb | 78 - .../monitor_tune/udp_communication.html.md.erb | 50 - .../chapter_overview.html.md.erb | 48 - .../failure_detection.html.md.erb | 62 - .../handling_network_partitioning.html.md.erb | 63 - ...rk_partitioning_management_works.html.md.erb | 59 - ...ators_lead_members_and_weighting.html.md.erb | 79 - .../network_partitioning_scenarios.html.md.erb | 53 - .../preventing_network_partitions.html.md.erb | 28 - .../region_compression.html.md.erb | 226 -- .../authentication_examples.html.md.erb | 70 - .../authentication_overview.html.md.erb | 43 - .../security/authorization_example.html.md.erb | 70 - .../security/authorization_overview.html.md.erb | 34 - .../security/chapter_overview.html.md.erb | 47 - .../security/enable_security.html.md.erb | 73 - .../security/encrypting_passwords.html.md.erb | 49 - .../encrypting_with_diffie_helman.html.md.erb | 66 - .../implementing_authentication.html.md.erb | 142 - .../implementing_authorization.html.md.erb | 265 -- .../security/implementing_security.html.md.erb | 80 - .../security/implementing_ssl.html.md.erb | 226 -- .../security/post_processing.html.md.erb | 67 - .../security/properties_file.html.md.erb | 34 - .../security/security-audit.html.md.erb | 64 - .../security_audit_overview.html.md.erb | 39 - .../security/security_intro.html.md.erb | 38 - .../managing/security/ssl_example.html.md.erb | 105 - .../managing/security/ssl_overview.html.md.erb | 45 - .../application_defined_statistics.html.md.erb | 39 - .../statistics/chapter_overview.html.md.erb | 42 - .../statistics/how_statistics_work.html.md.erb | 34 - .../setting_up_statistics.html.md.erb | 151 - ...ient_region_and_entry_statistics.html.md.erb | 42 - .../statistics/viewing_statistics.html.md.erb | 24 - .../chapter_overview.html.md.erb | 60 - .../diagnosing_system_probs.html.md.erb | 437 --- ...ent_and_recover_disk_full_errors.html.md.erb | 45 - ...ducing_troubleshooting_artifacts.html.md.erb | 92 - ...ring_conflicting_data_exceptions.html.md.erb | 75 - .../recovering_from_app_crashes.html.md.erb | 32 - .../recovering_from_cs_crashes.html.md.erb | 54 - .../recovering_from_machine_crashes.html.md.erb | 62 - .../recovering_from_network_outages.html.md.erb | 73 - .../recovering_from_p2p_crashes.html.md.erb | 231 -- .../system_failure_and_recovery.html.md.erb | 283 -- geode-docs/prereq_and_install.html.md.erb | 40 - geode-docs/reference/book_intro.html.md.erb | 48 - .../statistics/statistics_list.html.md.erb | 1293 ------- .../topics/cache-elements-list.html.md.erb | 185 - .../reference/topics/cache_xml.html.md.erb | 3107 ---------------- .../chapter_overview_cache_xml.html.md.erb | 47 - ...chapter_overview_regionshortcuts.html.md.erb | 107 - .../client-cache-elements-list.html.md.erb | 137 - .../reference/topics/client-cache.html.md.erb | 2683 -------------- .../reference/topics/elements_ref.html.md.erb | 117 - .../topics/gemfire_properties.html.md.erb | 640 ---- .../reference/topics/gfe_cache_xml.html.md.erb | 3414 ------------------ .../reference/topics/glossary.html.md.erb | 618 ---- ...handling_exceptions_and_failures.html.md.erb | 32 - ...mory_requirements_for_cache_data.html.md.erb | 301 -- ...on-ascii_strings_in_config_files.html.md.erb | 43 - .../region_shortcuts_reference.html.md.erb | 1499 -------- .../topics/region_shortcuts_table.html.md.erb | 519 --- geode-docs/rest_apps/book_intro.html.md.erb | 59 - .../rest_apps/chapter_overview.html.md.erb | 32 - .../rest_apps/delete_all_data.html.md.erb | 56 - .../rest_apps/delete_data_for_key.html.md.erb | 56 - .../delete_data_for_multiple_keys.html.md.erb | 56 - .../rest_apps/delete_named_query.html.md.erb | 60 - .../rest_apps/develop_rest_apps.html.md.erb | 683 ---- .../get_execute_adhoc_query.html.md.erb | 120 - geode-docs/rest_apps/get_functions.html.md.erb | 67 - geode-docs/rest_apps/get_queries.html.md.erb | 72 - .../rest_apps/get_region_data.html.md.erb | 132 - ...et_region_data_for_multiple_keys.html.md.erb | 238 -- .../rest_apps/get_region_key_data.html.md.erb | 87 - .../rest_apps/get_region_keys.html.md.erb | 67 - geode-docs/rest_apps/get_regions.html.md.erb | 95 - geode-docs/rest_apps/get_servers.html.md.erb | 64 - .../rest_apps/head_region_size.html.md.erb | 62 - geode-docs/rest_apps/ping_service.html.md.erb | 54 - .../rest_apps/post_create_query.html.md.erb | 106 - .../post_execute_functions.html.md.erb | 142 - .../rest_apps/post_execute_query.html.md.erb | 172 - .../rest_apps/post_if_absent_data.html.md.erb | 144 - .../put_multiple_values_for_keys.html.md.erb | 103 - .../rest_apps/put_replace_data.html.md.erb | 83 - .../rest_apps/put_update_cas_data.html.md.erb | 215 -- .../rest_apps/put_update_data.html.md.erb | 82 - .../rest_apps/put_update_query.html.md.erb | 85 - geode-docs/rest_apps/rest_admin.html.md.erb | 32 - .../rest_apps/rest_api_reference.html.md.erb | 43 - geode-docs/rest_apps/rest_examples.html.md.erb | 708 ---- geode-docs/rest_apps/rest_functions.html.md.erb | 32 - geode-docs/rest_apps/rest_prereqs.html.md.erb | 37 - geode-docs/rest_apps/rest_queries.html.md.erb | 48 - geode-docs/rest_apps/rest_regions.html.md.erb | 82 - geode-docs/rest_apps/setup_config.html.md.erb | 179 - .../rest_apps/troubleshooting.html.md.erb | 169 - geode-docs/rest_apps/using_swagger.html.md.erb | 71 - .../gemcached/about_gemcached.html.md.erb | 46 - .../gemcached/advantages.html.md.erb | 36 - .../gemcached/chapter_overview.html.md.erb | 40 - .../gemcached/deploying_gemcached.html.md.erb | 97 - .../tools_modules/gfsh/about_gfsh.html.md.erb | 42 - .../gfsh/cache_xml_2_gfsh.html.md.erb | 105 - .../gfsh/chapter_overview.html.md.erb | 66 - .../gfsh/command-pages/alter.html.md.erb | 520 --- .../gfsh/command-pages/backup.html.md.erb | 85 - .../gfsh/command-pages/change.html.md.erb | 98 - .../gfsh/command-pages/clear.html.md.erb | 50 - .../gfsh/command-pages/close.html.md.erb | 141 - .../gfsh/command-pages/compact.html.md.erb | 114 - .../gfsh/command-pages/configure.html.md.erb | 85 - .../gfsh/command-pages/connect.html.md.erb | 172 - .../gfsh/command-pages/create.html.md.erb | 954 ----- .../gfsh/command-pages/debug.html.md.erb | 54 - .../gfsh/command-pages/define.html.md.erb | 68 - .../gfsh/command-pages/deploy.html.md.erb | 78 - .../gfsh/command-pages/describe.html.md.erb | 409 --- .../gfsh/command-pages/destroy.html.md.erb | 178 - .../gfsh/command-pages/disconnect.html.md.erb | 56 - .../gfsh/command-pages/echo.html.md.erb | 66 - .../gfsh/command-pages/encrypt.html.md.erb | 57 - .../gfsh/command-pages/execute.html.md.erb | 59 - .../gfsh/command-pages/exit.html.md.erb | 40 - .../gfsh/command-pages/export.html.md.erb | 271 -- .../gfsh/command-pages/gc.html.md.erb | 58 - .../gfsh/command-pages/get.html.md.erb | 67 - .../gfsh/command-pages/help.html.md.erb | 77 - .../gfsh/command-pages/hint.html.md.erb | 78 - .../gfsh/command-pages/history.html.md.erb | 59 - .../gfsh/command-pages/import.html.md.erb | 100 - .../gfsh/command-pages/list.html.md.erb | 474 --- .../gfsh/command-pages/load-balance.html.md.erb | 64 - .../gfsh/command-pages/locate.html.md.erb | 72 - .../gfsh/command-pages/netstat.html.md.erb | 139 - .../gfsh/command-pages/pause.html.md.erb | 51 - .../gfsh/command-pages/pdx.html.md.erb | 90 - .../gfsh/command-pages/put.html.md.erb | 78 - .../gfsh/command-pages/query.html.md.erb | 69 - .../gfsh/command-pages/rebalance.html.md.erb | 73 - .../gfsh/command-pages/remove.html.md.erb | 63 - .../gfsh/command-pages/resume.html.md.erb | 51 - .../gfsh/command-pages/revoke.html.md.erb | 65 - .../gfsh/command-pages/run.html.md.erb | 105 - .../gfsh/command-pages/set.html.md.erb | 70 - .../gfsh/command-pages/sh.html.md.erb | 63 - .../gfsh/command-pages/show.html.md.erb | 302 -- .../gfsh/command-pages/shutdown.html.md.erb | 62 - .../gfsh/command-pages/sleep.html.md.erb | 57 - .../gfsh/command-pages/start.html.md.erb | 776 ---- .../gfsh/command-pages/status.html.md.erb | 298 -- .../gfsh/command-pages/stop.html.md.erb | 227 -- .../gfsh/command-pages/undeploy.html.md.erb | 77 - .../gfsh/command-pages/validate.html.md.erb | 48 - .../gfsh/command-pages/version.html.md.erb | 60 - .../gfsh/command_scripting.html.md.erb | 37 - .../gfsh/configuring_gfsh.html.md.erb | 129 - .../gfsh/getting_started_gfsh.html.md.erb | 156 - .../gfsh/gfsh_command_index.html.md.erb | 224 -- .../gfsh/gfsh_quick_reference.html.md.erb | 58 - .../gfsh/os_command_line_execution.html.md.erb | 50 - .../gfsh/quick_ref_commands_by_area.html.md.erb | 318 -- .../gfsh/starting_gfsh.html.md.erb | 75 - .../tools_modules/gfsh/tour_of_gfsh.html.md.erb | 457 --- .../useful_gfsh_shell_variables.html.md.erb | 72 - .../chapter_overview.html.md.erb | 60 - .../common_gemfire_topologies.html.md.erb | 36 - .../http_why_use_gemfire.html.md.erb | 56 - .../interactive_mode_ref.html.md.erb | 142 - .../http_session_mgmt/quick_start.html.md.erb | 118 - .../session_mgmt_tcserver.html.md.erb | 38 - .../session_mgmt_tomcat.html.md.erb | 38 - .../session_mgmt_weblogic.html.md.erb | 34 - .../session_state_log_files.html.md.erb | 111 - .../tc_additional_info.html.md.erb | 52 - .../tc_changing_gf_default_cfg.html.md.erb | 98 - .../tc_installing_the_module.html.md.erb | 38 - .../tc_setting_up_the_module.html.md.erb | 139 - .../tomcat_changing_gf_default_cfg.html.md.erb | 170 - .../tomcat_installing_the_module.html.md.erb | 38 - .../tomcat_setting_up_the_module.html.md.erb | 120 - ...weblogic_changing_gf_default_cfg.html.md.erb | 179 - ...gic_common_configuration_changes.html.md.erb | 52 - .../weblogic_setting_up_the_module.html.md.erb | 213 -- .../pulse/chapter_overview.html.md.erb | 49 - .../tools_modules/pulse/quickstart.html.md.erb | 827 ----- .../pulse/system_requirements.html.md.erb | 35 - .../tools_modules/redis_adapter.html.md.erb | 90 - .../topologies_and_comm/book_intro.html.md.erb | 42 - .../chapter_overview.html.md.erb | 52 - ...nt_server_example_configurations.html.md.erb | 164 - .../client_server_whats_next.html.md.erb | 56 - ...gure_servers_into_logical_groups.html.md.erb | 54 - ...etting_up_a_client_server_system.html.md.erb | 87 - ...tandard_client_server_deployment.html.md.erb | 35 - .../chapter_overview.html.md.erb | 44 - .../multisite_topologies.html.md.erb | 67 - .../setting_up_a_multisite_system.html.md.erb | 381 -- .../chapter_overview.html.md.erb | 36 - .../configuring_peer_member_groups.html.md.erb | 60 - .../setting_up_a_p2p_system.html.md.erb | 42 - .../setting_up_peer_communication.html.md.erb | 64 - .../topology_concepts/IPv4_and_IPv6.html.md.erb | 49 - .../chapter_overview.html.md.erb | 48 - .../how_communication_works.html.md.erb | 62 - .../how_member_discovery_works.html.md.erb | 60 - .../how_multisite_systems_work.html.md.erb | 44 - .../how_server_discovery_works.html.md.erb | 77 - ...how_the_pool_manages_connections.html.md.erb | 78 - .../member_communication.html.md.erb | 46 - .../multisite_overview.html.md.erb | 122 - .../topology_types.html.md.erb | 48 - .../using_bind_addresses.html.md.erb | 112 - 654 files changed, 64584 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/.gitignore ---------------------------------------------------------------------- diff --git a/geode-docs/.gitignore b/geode-docs/.gitignore deleted file mode 100644 index eaf0351..0000000 --- a/geode-docs/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -geode-book/Gemfile.lock -geode-book/final_app -geode-book/output -out -temp -*.bak http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/CONTRIBUTE.md ---------------------------------------------------------------------- diff --git a/geode-docs/CONTRIBUTE.md b/geode-docs/CONTRIBUTE.md deleted file mode 100644 index dd97f47..0000000 --- a/geode-docs/CONTRIBUTE.md +++ /dev/null @@ -1,63 +0,0 @@ -# Contributing to the Project Geode Documentation - -Project Geode welcomes your contributions to the community's documentation efforts. You can participate by writing new content, reviewing and editing existing content, or fixing bugs. This document covers the following topics: - -- [How to Contribute](#contribute) -- [Document Source Files and Tools](#source_tools) -- [Writing Guidelines](#guidelines) - -[]() - -## How to Contribute - -We use the fork-and-pull collaboration method on GitHub: - -1. In your GitHub account, fork the gemfire/docs-geode-md repository. -2. Create a local clone of your fork. -3. Make changes and commit them in your fork. -4. In the gemfire/docs-geode-md repository, create a pull request. - -See [Using Pull Requests](https://help.github.com/articles/using-pull-requests/) on GitHub for more about the fork-and-pull collaboration method. - -[]() - -## Document Source Files and Tools - -Project Geode documentation source files are written in markdown. Image files include .gif and .png graphics and editable image files in the open source SVG format. - -- [Working with Markdown Files](#markdown) -- [Working with Images and Graphics](#images) - -[]() - -### Working with Markdown Files - -You can edit markdown files in any text editor. For more, read [Daring Fireball's Markdown Syntax page](https://daringfireball.net/projects/markdown/syntax). - -[]() - -### Working with Images and Graphics - -Image files in .gif or .png format are in the `images` directory in the Project Geode docs repo. Images in .svg format are in the `images_svg` directory. - -Most of the Project Geode image files have been converted to the open source SVG format. You can insert SVG images directly into an XML topic and modify images using a SVG editor. - -The Wikipedia page [Comparison of Vector Graphics Editors](http://en.wikipedia.org/wiki/Comparison_of_vector_graphics_editors) provides a list and comparison of commercial and free vector graphics editors. Note, however, that not all of these programs support the SVG format. - -[]() - -## Writing Guidelines - -The most important advice we can provide for working with the Project Geode docs is to spend some time becoming familiar with the existing source files and the structure of the project directory. In particular, note the following conventions and tips: - -- Top-level subdirectories organize topics into "books": basic_config, configuring, developing, etc. - -- Use lowercase characters for all file and directory names. Separate words in filenames with an underscore (`_`) character. - -- Use the `.md` file extension for topic files. - -- Add new topics to the existing directories by subject type. Only create a new directory if you are starting a new subject or a new book. - -- To start a new topic, you can make a copy of an existing file with similar content and edit it. - -- Use the appropriate document type for the content you are writing. Create multiple topics if you are writing overview, procedural, and reference content. http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/README.md ---------------------------------------------------------------------- diff --git a/geode-docs/README.md b/geode-docs/README.md deleted file mode 100644 index a018ca1..0000000 --- a/geode-docs/README.md +++ /dev/null @@ -1,93 +0,0 @@ -# Project Geode End-User Documentation - -The latest check-ins to `project-geode/docs` are automatically built and published to <http://geode-docs.cfapps.io>. - -Project Geode provides the full source for end-user documentation in markdown format. The markdown can be built into HTML using [Bookbinder](https://github.com/pivotal-cf/bookbinder). - -Bookbinder is a gem that binds together a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application. - -This document contains instructions for building the local Geode documentation and publishing it to Cloud Foundry or Pivotal Web Services. It contains the sections: - -- [Bookbinder Usage](#usage) -- [Prerequisites](#prereq) -- [Building the Documentation](#building) -- [Publishing the Documentation](#publishing) -- [Getting More Information](#moreinfo) - -[]() - -## Bookbinder Usage - -Bookbinder is meant to be used from within a project called a **book**. The book includes a configuration file that describes which documentation repositories to use as source materials. Bookbinder provides a set of scripts to aggregate those repositories and publish them to various locations. - -For Geode, a preconfigured **book** is provided in the directory `/geode-book`. You can use this configuration to build HTML for project Geode on your local system. - -[]() - -## Prerequisites - -- Bookbinder requires Ruby version 2.0.0-p195 or higher. - -## Building the Documentation - -1. Begin by moving or copying the `/geode-book directory` to a directory that is parallel to `project-geode/docs`. For example: - - ``` - $ cd /repos/project-geode/docs - $ cp -r geode-book .. - $ cd ../geode-book - ``` - -2. The GemFile in the book directory already defines the `gem "bookbindery"` dependency. Make sure you are in the relocated book directory and enter: - - ``` - $ bundle install - ``` - -3. The installed `config.yml` file configures the Project Geode book for building locally. The installed file configures the local directory for the markdown source files. It uses the configuration: - - ``` - book_repo: project-geode/geode-book - public_host: localhost - - sections: - - repository: - name: gemfire/docs-geode-md - directory: docs-geode - subnav_template: geode-nav - - template_variables: - product_url: http://geode.incubator.apache.org - book_title: Project Geode Documentation - ``` - -4. Build the files locally using the installed `config.yml` file. Execute the command: - - ``` - $ bundle exec bookbinder bind local - ``` - - Bookbinder converts the markdown source into HTML, putting the final output in the `final_app` directory. - -5. To view the local documentation: - - ``` - $ cd final_app - $ rackup - ``` - - You can now view the local documentation at <http://localhost:9292> - -[]() - -## Publishing the Documentation - -Because the `final_app` directory contains the full output of the HTML conversion process, you can easily publish this directory as a hosted Web application. - -[]() - -## Getting More Information - -Bookbinder provides additional functionality to construct books from multiple Github repos, to perform variable substitution, and also to automatically build documentation in a continuous integration pipeline. For more information, see <https://github.com/pivotal-cf/bookbinder>. - -The latest check-ins to `gemfire/docs-geode-md` are automatically built and published to <http://geode-docs.cfapps.io>. http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/about_geode.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/about_geode.html.md.erb b/geode-docs/about_geode.html.md.erb deleted file mode 100644 index b4f090f..0000000 --- a/geode-docs/about_geode.html.md.erb +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Apache Geode 1.0.0-incubating Documentation ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -This documentation describes product concepts and provides complete setup instructions for Apache Geode 1.0.0-incubating. Source files and instructions on how to build this documentation are available at [https://github.com/project-geode/docs](https://github.com/project-geode/docs) and [https://github.com/project-geode/docs/blob/master/README.md](https://github.com/project-geode/docs/blob/master/README.md). - -You can also find additional documentation about Geode on the **Apache Geode Wiki**: [https://cwiki.apache.org/confluence/display/GEODE/Index](https://cwiki.apache.org/confluence/display/GEODE/Index). - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/book_intro.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/book_intro.html.md.erb b/geode-docs/basic_config/book_intro.html.md.erb deleted file mode 100644 index 757195d..0000000 --- a/geode-docs/basic_config/book_intro.html.md.erb +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Basic Configuration and Programming ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -*Basic Configuration and Programming* describes how to configure distributed system and cache properties for your Apache Geode installation. For your applications, it provides guidance for writing code to manage your cache and distributed system connection, data regions, and data entries, including custom classes. - -- **[Distributed System and Cache Configuration](../basic_config/config_concepts/chapter_overview.html)** - - To work with your Apache Geode applications, you use a combination of configuration files and application code. - -- **[Cache Management](../basic_config/the_cache/chapter_overview.html)** - - The Geode cache is the entry point to Geode caching management. Geode provides different APIs and XML configuration models to support the behaviors of different members. - -- **[Data Regions](../basic_config/data_regions/chapter_overview.html)** - - The region is the core building block of the Apache Geode distributed system. All cached data is organized into data regions and you do all of your data puts, gets, and querying activities against them. - -- **[Data Entries](../basic_config/data_entries_custom_classes/chapter_overview.html)** - - The data entry is the key/value pair where you store your data. You can manage your entries individually and in batches. To use domain objects for your entry values and keys, you need to follow Apache Geode requirements for data storage and distribution. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/config_concepts/chapter_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/config_concepts/chapter_overview.html.md.erb b/geode-docs/basic_config/config_concepts/chapter_overview.html.md.erb deleted file mode 100644 index a5df468..0000000 --- a/geode-docs/basic_config/config_concepts/chapter_overview.html.md.erb +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Distributed System and Cache Configuration ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -To work with your Apache Geode applications, you use a combination of configuration files and application code. - -- **[Distributed System Members](../../basic_config/config_concepts/distributed_system_member_configuration.html)** - - Distributed system members are programs that connect to a Geode distributed system. You configure members to belong to a single distributed system, and you can optionally configure them to be clients or servers to members in other distributed systems, and to communicate with other distributed systems. - -- **[Setting Properties](../../basic_config/gemfire_properties/setting_distributed_properties.html)** - - Geode provides a default distributed system configuration for out-of-the-box systems. To use non-default configurations and to fine-tune your member communication, you can use a mix of various options to customize your distributed system configuration. - -- **[Options for Configuring the Cache and Data Regions](../../basic_config/the_cache/setting_cache_properties.html)** - - To populate your Apache Geode cache and fine-tune its storage and distribution behavior, you need to define cached data regions and provide custom configuration for the cache and regions. - -- **[Local and Remote Membership and Caching](../../basic_config/config_concepts/local_vs_remote.html)** - - For many Apache Geode discussions, you need to understand the difference between local and remote membership and caching. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/config_concepts/distributed_system_member_configuration.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/config_concepts/distributed_system_member_configuration.html.md.erb b/geode-docs/basic_config/config_concepts/distributed_system_member_configuration.html.md.erb deleted file mode 100644 index a06a8c8..0000000 --- a/geode-docs/basic_config/config_concepts/distributed_system_member_configuration.html.md.erb +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Distributed System Members ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -Distributed system members are programs that connect to a Geode distributed system. You configure members to belong to a single distributed system, and you can optionally configure them to be clients or servers to members in other distributed systems, and to communicate with other distributed systems. - -## <a id="distributed_system_member_configuration__section_326B2609B67E4FBE9BF2074C3B211E50" class="no-quick-link"></a>Member Overview - -Distributed system members (or simply "members") connect to the Geode system when they create the Geode data cache. The members' distributed system is configured through Geode properties. See [gemfire.properties and gfsecurity.properties (Geode Properties)](../../reference/topics/gemfire_properties.html). Geode properties specify all necessary information for system member startup, initialization, and communication. - -**Note:** -You cannot change a member's properties while the member is connected to the distributed system. - -Use the properties to define: - -- How to find and communicate with other system members -- How to perform logging and statistics activities -- Which persistent configuration or `cache.xml` file to use for cache and data region initialization -- Other options, including event conflation, how to handle network loss, and security settings - -## <a id="distributed_system_member_configuration__section_E755E9E4A31149C980561D617A99A002" class="no-quick-link"></a>Distributed System Membership and System Topologies - -Every Geode process is a member of a distributed system, even if the distributed system is defined as standalone, with just one member. You can run an individual distributed system in isolation or you can combine systems for vertical and horizontal scaling. See [Topology and Communication General Concepts](../../topologies_and_comm/topology_concepts/chapter_overview.html). - -- **Peer-to-Peer Distributed Systems**. Members that define the same member discovery properties belong to the same distributed system and are peers to one another. -- **Client/Server Installations**. The client/server topology uses relationships that you configure between members of multiple distributed systems. You configure some or all of the peers in one distributed system to act as cache servers to clients connecting from outside the system. Each server can host many client processes, managing cache access for all in an efficient, vertically hierarchical cache configuration. You configure the client applications to connect to the servers, using a client cache configuration. Clients run as members of standalone Geode distributed systems, with no peers, so all data updates and requests go to the servers. - -## **Multi-site Installations** - -The multi-site topology uses relationships that you configure between members of multiple distributed systems. Through this configuration, you loosely couple two or more distributed systems for automated data distribution. This is usually done for sites at geographically separate locations. You configure a subset of peers in each distributed system site with gateway senders and/or gateway receivers to manage events that are distributed between the sites. - -In the context of a single distributed system, unless otherwise specified, remote members refers to other members of the same distributed system. In client/server and multi-site installations, remote generally refers to members in other distributed systems. For example, all servers are remote to the clients that connect to them. Each client runs standalone, with connections only to the server tier, so all servers and their other clients are remote to the individual client. All gateway receivers are remote to the gateway senders that connect to them from other distributed systems,and to those gateway sendersâ peers. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/config_concepts/local_vs_remote.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/config_concepts/local_vs_remote.html.md.erb b/geode-docs/basic_config/config_concepts/local_vs_remote.html.md.erb deleted file mode 100644 index 535f2fd..0000000 --- a/geode-docs/basic_config/config_concepts/local_vs_remote.html.md.erb +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Local and Remote Membership and Caching ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -For many Apache Geode discussions, you need to understand the difference between local and remote membership and caching. - -<a id="local_vs_remote_member_and_cache__section_5535DC4C94494B6A9B106DA39F63A439"></a> -Discussions of Geode membership and caching activities often differentiate between local and remote. Local caching always refers to the central member under discussion, if there is one such obvious member, and remote refers to other members. If there is no clear, single local member, the discussion assigns names to the members to differentiate. Operations, data, configuration, and so forth that are "local to member Q" are running or resident inside the member Q process. Operations, data, configuration, and so on, that are "remote to member Q" are running or resident inside some other member. - -The local cache is the cache belonging to the local member. All other caches are remote, whether in other members of the same distributed system or in different distributed systems. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/data_entries_custom_classes/chapter_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/data_entries_custom_classes/chapter_overview.html.md.erb b/geode-docs/basic_config/data_entries_custom_classes/chapter_overview.html.md.erb deleted file mode 100644 index 0dd9f68..0000000 --- a/geode-docs/basic_config/data_entries_custom_classes/chapter_overview.html.md.erb +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Data Entries ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -The data entry is the key/value pair where you store your data. You can manage your entries individually and in batches. To use domain objects for your entry values and keys, you need to follow Apache Geode requirements for data storage and distribution. - -- **[Managing Data Entries](../../basic_config/data_entries_custom_classes/managing_data_entries.html)** - - Program your applications to create, modify, and manage your cached data entries. - -- **[Requirements for Using Custom Classes in Data Caching](../../basic_config/data_entries_custom_classes/using_custom_classes.html)** - - Follow these guidelines to use custom domain classes for your cached entry keys and values. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/data_entries_custom_classes/managing_data_entries.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/data_entries_custom_classes/managing_data_entries.html.md.erb b/geode-docs/basic_config/data_entries_custom_classes/managing_data_entries.html.md.erb deleted file mode 100644 index 3b3f62f..0000000 --- a/geode-docs/basic_config/data_entries_custom_classes/managing_data_entries.html.md.erb +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Managing Data Entries ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -Program your applications to create, modify, and manage your cached data entries. - -<a id="managing_data_entries__section_AACC36127F17411F86D1E409B86C6E5C"></a> -**Note:** -If you do not have the cache's `copy-on-read` attribute set to true, do not change the objects returned from the Java entry access methods. Instead, create a copy of the object, then modify the copy and pass it to the Java `put` method. Modifying a value in place bypasses the entire distribution framework provided by Geode, including cache listeners and expiration activities, and can produce undesired results. - -## <a id="managing_data_entries__section_B095A4073EFB4A3C91AF7C03632EEBFB" class="no-quick-link"></a>Basic Create and Update - -To create or update an entry in the cache, use `Region.put`. For example: - -``` pre -String name = ... -String value = ... -this.currRegion.put(name,value); -``` - -**Note:** -You can also use the `gfsh put` command to add entries to a region, and the `get` command to retrieve entries from a region. See [get](../../tools_modules/gfsh/command-pages/get.html) and [put](../../tools_modules/gfsh/command-pages/put.html) for more information. - -If you want only to create the entry (with a null value and with method failure if the entry already exists), use `Region.create` instead. - -## <a id="managing_data_entries__section_7578349EA26A4621B732FE851D71A84F" class="no-quick-link"></a>Batch Operations (getAll, putAll, removeAll) - -Geode provides three APIs to perform batch operations on multiple region entries: - -- `Region.getAll` -- `Region.putAll` -- `Region.removeAll` - -The `getAll` method takes a collection of keys and returns a `Map` of values for the provided keys. If a given key does not exist in the region, then that key's value in the returned map will be null. - -The `putAll` method takes a `Map` of key-value pairs and puts them into the cache and distributes them in a single operation. - -**Example:** - -``` pre -void putAll(String command) throws CacheException -{ -// Get Entry keys and values into Strings key1, ... keyN and value1, ... valueN - Map map = new LinkedHashMap(); - map.put(key1, value1)); - ... - map.put(keyN, valueN)); - this.currRegion.putAll(map); -} -``` - -The updates to the cache are done individually in the order in which they were placed in the `Map`. For partitioned regions, multiple events are sent as a single message to the primary buckets and then distributed to the secondary buckets. - -**Note:** -The processing of maps with very many entries and/or very large data may affect system performance and cause cache update timeouts, especially if the region uses overflow or persistence to disk. - -The `removeAll` method takes a collection of keys and removes all of the entries for the specified keys from this region. This call performs the equivalent of calling`destroy(Object)` on this region once for each key in the specified collection. If an entry does not exist, then that key is skipped. An `EntryNotFoundException` is not thrown. This operation will be distributed to other caches if the region's scope is not set to `Scope.LOCAL`. - -## <a id="managing_data_entries__section_A0E0F889AC344EFA8DF304FD64418809" class="no-quick-link"></a>Safe Entry Modification - -When you get an entry value from the cache, by default, the retrieval methods return a direct reference to the cached object. This provides the value as quickly as possible, but also opens the cache to direct, in-place changes. - -**Note:** -Do not directly modify cached values. Modifying a value in place bypasses the Geode distribution framework, including cache writers and listeners, expiration activities, and transaction management, and can produce undesired results. - -Always change your entries using copies of the retrieved objectsânever directly modify the returned objects. You can do this in one of two ways: - -1. Change the entry retrieval behavior for your cache by setting the cache attribute, `copy-on-read`, to true (the default is false). - - ``` pre - <cache copy-on-read="true"> - ... - </cache> - ``` - - When `copy-on-read` is true, the entry access methods return copies of the entries. This protects you from inadvertently modifying in-place, but negatively impacts performance and memory consumption when copying is not needed. - - These entry access methods return an entry reference if `copy-on-read` is false and a copy of the entry if `copy-on-read` is true: - - `Region.get` - result of `Region.put` - `EntryEvent.getNewValue` - `Region.values` - `Region.Entry.getValue` - `EntryEvent.getOldValue` - `Query.select` - -2. Create a copy of the returned object and work with that. For objects that are cloneable or serializable, you can copy the entry value to a new object using `org.apache.geode.CopyHelper.copy`. Example: - - ``` pre - Object o = (StringBuffer)region.get("stringBuf"); - StringBuffer s = (StringBuffer) CopyHelper.copy(o); - s.append("Changes to value, added using put."); - region.put("stringBuf", s); - ``` - -## <a id="managing_data_entries__section_78F6731642944DE594316B86ECB4E70F" class="no-quick-link"></a>Retrieving Region Entries from Proxy Members - -The `Region.values` method call applies to the local region instance only. If you call the `values` method from a client region using the PROXY shortcut, the method call will not be redirected to the server region. To obtain a collection of all values in the Region from a client, you should use interest registration on ALL\_KEYS, or use a query. - -If you use the `Region.get` method from a proxy member, the method call will redirect to the region on the server if it cannot find the key locally. - -## Using gfsh to get and put - -You can use the gfsh `get` and `put` commands to manage data. See [get](../../tools_modules/gfsh/command-pages/get.html) and [put](../../tools_modules/gfsh/command-pages/put.html). - -For example: - -``` pre -get --key=('id':'133abg124') --region=region1 - -// Retrieving when key type is a wrapper(primitive)/String -get --key=('133abg124') --region=/region1/region12 --value-class=data.ProfileDetails - -get --key=('100L') --region=/region1/region12 --value-class=data.ProfileDetails ---key-class=java.lang.Long -``` - -``` pre -put --key=('id':'133abg125') --value=('firstname':'James','lastname':'Gosling') ---region=/region1 --key-class=data.ProfileKey --value-class=data.ProfileDetails - -put --key=('133abg124') --value=('Hello World!!') --region=/region2 - -put --key=('100F') --value=('2146547689879658564') --region=/region1/region12 ---key-class=java.lang.Float --value-class=java.lang.Long -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/data_entries_custom_classes/using_custom_classes.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/data_entries_custom_classes/using_custom_classes.html.md.erb b/geode-docs/basic_config/data_entries_custom_classes/using_custom_classes.html.md.erb deleted file mode 100644 index 698c04f..0000000 --- a/geode-docs/basic_config/data_entries_custom_classes/using_custom_classes.html.md.erb +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Requirements for Using Custom Classes in Data Caching ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -Follow these guidelines to use custom domain classes for your cached entry keys and values. - -## <a id="using_custom_classes__section_F098CAC546164094BE6872BF0C443A71" class="no-quick-link"></a>CLASSPATH - -Each memberâs `CLASSPATH` must include classes for all objects the member accesses. - -- For Java applications, use the standard Java `CLASSPATH`. -- For the cache server process, use the `CLASSPATH` environment variable or the `gfsh start server`'s `--classpath` parameter. See [Running Geode Server Processes](../../configuring/running/running_the_cacheserver.html). - -Data is sent between clients and servers in serialized form and the server stores client data in serialized form. The server does not need to deserialize data to send it to another client or to access it through a `PDXInstance`, but it does need to deserialize it to access it in other ways. The server `CLASSPATH` must include the classes for: - -- All entry keys -- Entry values in regions that the server persists to disk -- Entry values the server accesses for any reason other than access using a `PdxInstance` or transfer of the full entry value to a client - -For information on `PdxInstance`s, see [Data Serialization](../../developing/data_serialization/chapter_overview.html#data_serialization). - -## <a id="using_custom_classes__section_57EB5D02C06947B4BDE75A49286D581D" class="no-quick-link"></a>Data Serialization - -Geode serializes data entry keys and values for distribution, so all data that Geode moves out of the local cache for any reason must be serializable. Additionally, partitioned regions store data in serialized form. Almost every configuration requires serialization. - -For information on the requirements and options for data serialization, see [Data Serialization](../../developing/data_serialization/chapter_overview.html#data_serialization). - -## <a id="using_custom_classes__section_CE776B94EDCB4D269A71C3C9CFEDD5FD" class="no-quick-link"></a>Classes Used as Keys - -The region uses hashing on keys. If you define a custom class to use as a key, for the class, override: - -- `equals` -- `hashCode`. The default `hashCode` inherited from `Object` uses identity, which is different in every system member. In partitioned regions, hashing based on identity puts data in the wrong place. For details, see the Java API documentation for `java.lang.Object`. - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/data_regions/chapter_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/data_regions/chapter_overview.html.md.erb b/geode-docs/basic_config/data_regions/chapter_overview.html.md.erb deleted file mode 100644 index 4917259..0000000 --- a/geode-docs/basic_config/data_regions/chapter_overview.html.md.erb +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Data Regions ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -The region is the core building block of the Apache Geode distributed system. All cached data is organized into data regions and you do all of your data puts, gets, and querying activities against them. - -- **[Data Region Management](../../basic_config/data_regions/managing_data_regions.html)** - - Apache Geode provides different APIs and XML configuration models to support configuration and management of your data regions. - -- **[Creating a Region with gfsh](../../basic_config/data_regions/create_a_region_with_gfsh.html)** - - A simple and fast way to create a data region in the Apache Geode cache is to use the `gfsh` command-line tool. - -- **[Creating a Region Through the cache.xml File](../../basic_config/data_regions/create_a_region_with_cacheXML.html)** - - A common way to create a data region in the Apache Geode cache is through `cache.xml` declarations. - -- **[Creating a Region Through the API](../../basic_config/data_regions/create_a_region_with_API.html)** - - You can use the Geode caching API to create regions in your cache after startup. For run-time region creation, you need to use the API. - -- **[Region Naming](../../basic_config/data_regions/region_naming.html)** - - To be able to perform all available operations on your data regions, -follow these region naming guidelines. - -- **[Region Shortcuts and Custom Named Region Attributes](../../basic_config/data_regions/region_shortcuts.html)** - - Geode provides region shortcut settings, with preset region configurations for the most common region types. For the easiest configuration, start with a shortcut setting and customize as needed. You can also store your own custom configurations in the cache for use by multiple regions. - -- **[Storing and Retrieving Region Shortcuts and Custom Named Region Attributes](../../basic_config/data_regions/store_retrieve_region_shortcuts.html)** - - Use these examples to get started with Geode region shortcuts. - -- **[Managing Region Attributes](../../basic_config/data_regions/managing_region_attributes.html)** - - Use region attributes to fine-tune the region configuration provided by the region shortcut settings. - -- **[Creating Custom Attributes for Regions and Entries](../../basic_config/data_regions/creating_custom_attributes.html)** - - Use custom attributes to store information related to your region or its entries in your cache. These attributes are only visible to the local application and are not distributed. - -- **[Building a New Region with Existing Content](../../basic_config/data_regions/new_region_existing_data.html)** - - A new region or distributed system may need to be loaded with the data of an existing system. There are two approaches to accomplish this task. The approach used depends upon the organization of both the new and the existing distributed system. - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/data_regions/create_a_region_with_API.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/data_regions/create_a_region_with_API.html.md.erb b/geode-docs/basic_config/data_regions/create_a_region_with_API.html.md.erb deleted file mode 100644 index 8bb359b..0000000 --- a/geode-docs/basic_config/data_regions/create_a_region_with_API.html.md.erb +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Creating a Region Through the API ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -You can use the Geode caching API to create regions in your cache after startup. For run-time region creation, you need to use the API. - -Before you start, configure your `Cache` or `ClientCache` and determine the region shortcut and other attributes settings your region needs. - -Region creation is subject to attribute consistency checks, both internal to the cache and, if the region is not local, between all caches where the region is defined. The requirements for consistency between region attributes are detailed in the online Java API documentation. - -1. - - Use a region shortcut to create your region factory. - - - - In peers and servers, use `org.apache.geode.cache.RegionFactory`. - - - - In clients, use `org.apache.geode.cache.client.ClientRegionFactory`. - -2. - - (Optional) Use the region factory to further configure your region. -3. - - Create your region from the configured region factory. - -When you run your member with the region creation code, the region will be created in the cache. - -## Examples - -Creating a partitioned region using RegionFactory: - -``` pre -RegionFactory rf = - cache.createRegionFactory(RegionShortcut.PARTITION); -rf.addCacheListener(new LoggingCacheListener()); -custRegion = rf.create("customer"); -``` - -Creating a modified partitioned region using RegionFactory: - -``` pre -PartitionAttributesFactory paf = new PartitionAttributesFactory<CustomerId, String>(); -paf.setPartitionResolver(new CustomerOrderResolver()); - -RegionFactory rf = - cache.createRegionFactory(RegionShortcut.PARTITION); -rf.setPartitionAttributes(paf.create()); -rf.addCacheListener(new LoggingCacheListener()); -custRegion = rf.create("customer"); -``` - -Creating a client region with a pool specification using ClientRegionFactory: - -``` pre -ClientRegionFactory<String,String> cRegionFactory = - cache.createClientRegionFactory(PROXY); -Region<String, String> region = - cRegionFactory.setPoolName("Pool3").create("DATA"); -``` - - http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/84cfbdfc/geode-docs/basic_config/data_regions/create_a_region_with_cacheXML.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/basic_config/data_regions/create_a_region_with_cacheXML.html.md.erb b/geode-docs/basic_config/data_regions/create_a_region_with_cacheXML.html.md.erb deleted file mode 100644 index d7838f6..0000000 --- a/geode-docs/basic_config/data_regions/create_a_region_with_cacheXML.html.md.erb +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: Creating a Region Through the cache.xml File ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one or more -contributor license agreements. See the NOTICE file distributed with -this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 -(the "License"); you may not use this file except in compliance with -the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. ---> - -A common way to create a data region in the Apache Geode cache is through `cache.xml` declarations. - -Before you start, configure your `<cache>` or `<client-cache>` in your `cache.xml` file and determine the region shortcut and other attributes settings your region needs. The `cache.xml` file must conform to the schema definition provided in the product's `cache-1.0.xsd`. - -Region creation is subject to attribute consistency checks, both internal to the cache and, if the region is not local, between all caches where the region is defined. The requirements for consistency between region attributes are detailed in the online Java API documentation. - -1. - - In your `cache.xml` file, create a `<region>` element for your new region as a subelement to the `<cache>` element or the `<client-cache>` element. -2. - - Define your regionâs name and a region attributes shortcut setting, if one applies. Find the shortcut setting that most closely fits your region configuration. -3. - - Add other attributes as needed to customize the regionâs behavior. - -When you start your member with the `cache.xml` file, the region will be created. - -## Examples - -Partitioned Region Declaration - -``` pre -<region name="myRegion" refid="PARTITION"/> -``` - -Partitioned Region Declaration with Backup to Disk - -``` pre -<region name="myRegion" refid="PARTITION_PERSISTENT"/> -``` - -Partitioned Region Declaration with HA and Modified Storage Capacity in Host Member - -``` pre -<region name="myRegion" refid="PARTITION_REDUNDANT"> - <region-attributes> - <partition-attributes local-max-memory="512" /> - </region-attributes> -</region> -``` - -Replicated Region Declaration - -``` pre -<region name="myRegion" refid="REPLICATE"/> -``` - -Replicated Region Declaration with Event Listener and Expiration - -``` pre -<region name="myRegion" refid="REPLICATE"> - <region-attributes statistics-enabled="true"> - <entry-time-to-live> - <expiration-attributes timeout="60" action="destroy"/> - </entry-time-to-live> - <cache-listener> - <class-name>myPackage.MyCacheListener</class-name> - </cache-listener> - </region-attributes> -</region> -``` - -