blob: 046e0a8d54f966f86146cad61193dba722c8491a [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-61232409-1');
</script>
<meta charset="UTF-8">
<meta name="ignite-version" content="2.9.0" />
<title>Binary Type Metadata | Ignite Documentation</title>
<link rel="canonical" href="/docs/2.9.0/binary-client-protocol/binary-type-metadata" />
<link rel="stylesheet" href="/assets/css/styles.css?1600286556">
<link rel="stylesheet" href="/assets/css/asciidoc-pygments.css">
<link rel="shortcut icon" href="/favicon.ico">
<meta name='viewport' content='width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0'>
<script type="text/javascript" src="/assets/js/anchor.min.js?1600286556"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
</head>
<body>
<header>
<!--#include virtual="/includes/promotion_banner.html" -->
<div class="container">
<button type='button' class='menu' title='Docs menu'>
<img src="/assets/images/menu-icon.svg"/>
</button>
<div class='home'>
<a href="/" class='home' title='Apache Ignite home'>
<img src="/assets/images/apache_ignite_logo.svg" alt="Apache Ignite logo" width="103" >
</a>
</div>
<nav>
</nav>
<select id="version-selector">
<option value="2.9.0">2.9.0</option>
</select>
<a href="https://github.com/apache/ignite" title='GitHub' class='github' target="_blank">
<img src="/assets/images/github-gray.svg" alt="GitHub logo">
</a>
<form class='search'>
<button class="search-close" type='button'><img src='/assets/images/cancel.svg'></button>
<input type="search" placeholder="Search…" id="search-input">
</form>
<button type='button' class='search-toggle'><img src='/assets/images/search.svg'></button>
<button type='button' class='top-nav-toggle'></button>
</div>
</header>
<link rel="stylesheet" href="/assets/css/docs.css">
<section class='page-docs'>
<nav class='left-nav' data-swiftype-index='false'>
<li>
<a href="/docs/2.9.0/preface" class='' >Preface</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Quick Start Guides<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/quick-start/java"
class=''
>Java</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/dotnet"
class=''
>.NET/C#</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/cpp"
class=''
>C++</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/python"
class=''
>Python</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/nodejs"
class=''
>Node.JS</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/sql"
class=''
>SQL</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/php"
class=''
>PHP</a>
</li>
<li>
<a href="/docs/2.9.0/quick-start/restapi"
class=''
>REST API</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="/installation" class='group-toggle collapsed '>Installation<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/installation/installing-using-zip"
class=''
>Installing Using ZIP Archive</a>
</li>
<li>
<a href="/docs/2.9.0/installation/installing-using-docker"
class=''
>Installing Using Docker</a>
</li>
<li>
<a href="/docs/2.9.0/installation/deb-rpm"
class=''
>Installing DEB or RPM package</a>
</li>
<li>
<button
type='button'
class='collapsed '>Kubernetes<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//installation/kubernetes/amazon-eks-deployment" class=''>Amazon EKS</a></li>
<li><a href="/docs/2.9.0//installation/kubernetes/azure-deployment" class=''>Azure Kubernetes Service</a></li>
<li><a href="/docs/2.9.0//installation/kubernetes/gke-deployment" class=''>Google Kubernetes Engine</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Setting Up<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/setup"
class=''
>Setting Up Ignite for Java</a>
</li>
<li>
<a href="/docs/2.9.0/setup-dotnet"
class=''
>Setting Up Ignite for .NET/C#</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/understanding-configuration" class='' >Understanding Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/logging" class='' >Configuring Logging</a>
</li>
<li>
<a href="/docs/2.9.0/starting-nodes" class='' >Starting and Stopping Nodes</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Clustering<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/clustering/clustering"
class=''
>Overview</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/tcp-ip-discovery"
class=''
>TCP/IP Discovery</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/zookeeper-discovery"
class=''
>ZooKeeper Discovery</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/discovery-in-the-cloud"
class=''
>Discovery in the Cloud</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/network-configuration"
class=''
>Network Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/connect-client-nodes"
class=''
>Connecting Client Nodes</a>
</li>
<li>
<a href="/docs/2.9.0/clustering/running-client-nodes-behind-nat"
class=''
>Running Client Nodes Behind NAT</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Data Modeling<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/data-modeling/data-modeling"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/2.9.0/data-modeling/data-partitioning"
class=''
>Data Partitioning</a>
</li>
<li>
<a href="/docs/2.9.0/data-modeling/affinity-collocation"
class=''
>Affinity Colocation</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Configuring Memory<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/memory-architecture"
class=''
>Memory Architecture</a>
</li>
<li>
<a href="/docs/2.9.0/memory-configuration/data-regions"
class=''
>Configuring Data Regions</a>
</li>
<li>
<a href="/docs/2.9.0/memory-configuration/eviction-policies"
class=''
>Eviction Policies</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Configuring Caches<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/configuring-caches/configuration-overview"
class=''
>Cache Configuration</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/configuring-backups"
class=''
>Configuring Partition Backups</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/atomicity-modes"
class=''
>Atomicity Modes</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/expiry-policies"
class=''
>Expiry Policy</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/on-heap-caching"
class=''
>On-Heap Caching</a>
</li>
<li>
<a href="/docs/2.9.0/configuring-caches/cache-groups"
class=''
>Cache Groups</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Persistence<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/persistence/native-persistence"
class=''
>Ignite Persistence</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/external-storage"
class=''
>External Storage</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/swap"
class=''
>Swapping</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/custom-cache-store"
class=''
>Implementing Custom Cache Store</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/disk-compression"
class=''
>Disk Compression</a>
</li>
<li>
<a href="/docs/2.9.0/persistence/persistence-tuning"
class=''
>Tuning Persistence</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/baseline-topology" class='' >Baseline Topology</a>
</li>
<li>
<a href="/docs/2.9.0/cluster-states" class='' >Cluster States</a>
</li>
<li>
<a href="/docs/2.9.0/data-rebalancing" class='' >Data Rebalancing</a>
</li>
<li>
<a href="/docs/2.9.0/partition-loss-policy" class='' >Partition Loss Policy</a>
</li>
<li>
<a href="/docs/2.9.0/deploying-user-code" class='' >Deploying User Code</a>
</li>
<li>
<a href="/docs/2.9.0/peer-class-loading" class='' >Peer Class Loading</a>
</li>
<li>
<a href="/docs/2.9.0/data-streaming" class='' >Data Streaming</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Using Key-Value Cache API<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/key-value-api/basic-cache-operations"
class=''
>Basic Cache Operations</a>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/binary-objects"
class=''
>Working with Binary Objects</a>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/using-scan-queries"
class=''
>Using Scan Queries</a>
</li>
<li>
<a href="/docs/2.9.0/read-repair"
class=''
>Read Repair</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/continuous-queries" class='' >Using Continuous Queries</a>
</li>
<li>
<a href="/docs/2.9.0/key-value-api/transactions" class='' >Performing Transactions</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Working with SQL<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/SQL/sql-introduction"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/schemas"
class=''
>Understanding Schemas</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/indexes"
class=''
>Defining Indexes</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/sql-api"
class=''
>Using SQL API</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/distributed-joins"
class=''
>Distributed Joins</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/sql-transactions"
class=''
>SQL Transactions</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/custom-sql-func"
class=''
>Custom SQL Functions</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/JDBC/jdbc-driver"
class=''
>JDBC Driver</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/JDBC/jdbc-client-driver"
class=''
>JDBC Client Driver</a>
</li>
<li>
<a href="/docs/2.9.0/transactions/mvcc"
class=''
>Multiversion Concurrency Control</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Distributed Computing<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/distributed-computing/distributed-computing"
class=''
>Distributed Computing API</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/cluster-groups"
class=''
>Cluster Groups</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/executor-service"
class=''
>Executor Service</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/map-reduce"
class=''
>MapReduce API</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/load-balancing"
class=''
>Load Balancing</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/fault-tolerance"
class=''
>Fault Tolerance</a>
</li>
<li>
<a href="/docs/2.9.0/distributed-computing/job-scheduling"
class=''
>Job Scheduling</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/collocated-computations" class='' >Colocating Computations with Data</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Working with Events<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/events/listening-to-events"
class=''
>Enabling and Listenting to Events</a>
</li>
<li>
<a href="/docs/2.9.0/events/events"
class=''
>Events</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/near-cache" class='' >Near Caches</a>
</li>
<li>
<a href="/docs/2.9.0/platform-cache" class='' >.NET Platform Cache</a>
</li>
<li>
<a href="/docs/2.9.0/services/services" class='' >Services</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Distributed Data Structures<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/data-structures/queue-and-set"
class=''
>Queue and Set</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/atomic-types"
class=''
>Atomic Types</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/countdownlatch"
class=''
>CountDownLatch</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/atomic-sequence"
class=''
>Atomic Sequence</a>
</li>
<li>
<a href="/docs/2.9.0/data-structures/semaphore"
class=''
>Semaphore</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Machine Learning<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/machine-learning/machine-learning"
class=''
>Machine Learning</a>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/partition-based-dataset"
class=''
>Partition Based Dataset</a>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/updating-trained-models"
class=''
>Updating Trained Models</a>
</li>
<li>
<button
type='button'
class='collapsed '>Binary Classification<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//machine-learning/binary-classification/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/linear-svm" class=''>Linear SVM (Support Vector Machine)</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/decision-trees" class=''>Decision Trees</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/multilayer-perceptron" class=''>Multilayer Perceptron</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/logistic-regression" class=''>Logistic Regression</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/knn-classification" class=''>k-NN Classification</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/ann" class=''>ANN (Approximate Nearest Neighbor)</a></li>
<li><a href="/docs/2.9.0//machine-learning/binary-classification/naive-bayes" class=''>Naive Bayes</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Regression<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//machine-learning/regression/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//machine-learning/regression/linear-regression" class=''>Linear Regression</a></li>
<li><a href="/docs/2.9.0//machine-learning/regression/decision-trees-regression" class=''>Decision Trees Regression</a></li>
<li><a href="/docs/2.9.0//machine-learning/regression/knn-regression" class=''>k-NN Regression</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Clustering<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//machine-learning/clustering/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//machine-learning/clustering/k-means-clustering" class=''>K-Means Clustering</a></li>
<li><a href="/docs/2.9.0//machine-learning/clustering/gaussian-mixture" class=''>Gaussian mixture (GMM)</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/preprocessing"
class=''
>Preprocessing</a>
</li>
<li>
<button
type='button'
class='collapsed '>Model Selection<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//machine-learning/model-selection/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//machine-learning/model-selection/evaluator" class=''>Evaluator</a></li>
<li><a href="/docs/2.9.0//machine-learning/model-selection/split-the-dataset-on-test-and-train-datasets" class=''>Split the dataset on test and train datasets</a></li>
<li><a href="/docs/2.9.0//machine-learning/model-selection/hyper-parameter-tuning" class=''>Hyper-parameter tuning</a></li>
<li><a href="/docs/2.9.0//machine-learning/model-selection/pipeline-api" class=''>Pipeline API</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/multiclass-classification"
class=''
>Multiclass Classification</a>
</li>
<li>
<button
type='button'
class='collapsed '>Ensemble Methods<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//machine-learning/ensemble-methods/introduction" class=''></a></li>
<li><a href="/docs/2.9.0//machine-learning/ensemble-methods/stacking" class=''>Stacking</a></li>
<li><a href="/docs/2.9.0//machine-learning/ensemble-methods/baggin" class=''>Bagging</a></li>
<li><a href="/docs/2.9.0//machine-learning/ensemble-methods/random-forest" class=''>Random Forest</a></li>
<li><a href="/docs/2.9.0//machine-learning/ensemble-methods/gradient-boosting" class=''>Gradient Boosting</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/machine-learning/recommendation-systems"
class=''
>Recommendation Systems</a>
</li>
<li>
<button
type='button'
class='collapsed '>Importing Model<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//machine-learning/importing-model/introduction" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//machine-learning/importing-model/model-import-from-gxboost" class=''>Import Model from XGBoost</a></li>
<li><a href="/docs/2.9.0//machine-learning/importing-model/model-import-from-apache-spark" class=''>Import Model from Apache Spark</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Monitoring<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/monitoring-metrics/intro"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/cluster-id"
class=''
>Cluster ID and Tag</a>
</li>
<li>
<button
type='button'
class='collapsed '>Metrics<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//monitoring-metrics/configuring-metrics" class=''>Configuring Metrics</a></li>
<li><a href="/docs/2.9.0//monitoring-metrics/metrics" class=''>JMX Metrics</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>New Metrics System<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//monitoring-metrics/new-metrics-system" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//monitoring-metrics/new-metrics" class=''>Metrics</a></li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/system-views"
class=''
>System Views</a>
</li>
<li>
<a href="/docs/2.9.0/monitoring-metrics/tracing"
class=''
>Tracing</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="/security" class='group-toggle collapsed '>Security<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/security/authentication"
class=''
>Authentication</a>
</li>
<li>
<a href="/docs/2.9.0/security/ssl-tls"
class=''
>SSL/TLS</a>
</li>
<li>
<button
type='button'
class='collapsed '>Transparent Data Encryption<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/2.9.0//security/tde" class=''>Introduction</a></li>
<li><a href="/docs/2.9.0//security/master-key-rotation" class=''>Master key rotation</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle expanded '>Thin Clients<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group expanded'>
<li>
<a href="/docs/2.9.0/thin-clients/getting-started-with-thin-clients"
class=''
>Thin Clients Overview</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/java-thin-client"
class=''
>Java Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/dotnet-thin-client"
class=''
>.NET Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/cpp-thin-client"
class=''
>C++ Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/python-thin-client"
class=''
>Python Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/php-thin-client"
class=''
>PHP Thin Client</a>
</li>
<li>
<a href="/docs/2.9.0/thin-clients/nodejs-thin-client"
class=''
>Node.js Thin Client</a>
</li>
<li>
<button
type='button'
class='expanded parent '>Binary Client Protocol<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class="sub_pages expanded parent">
<li><a href="/docs/2.9.0//binary-client-protocol/binary-client-protocol" class=''>Binary Client Protocol</a></li>
<li><a href="/docs/2.9.0//binary-client-protocol/data-format" class=''>Data Format</a></li>
<li><a href="/docs/2.9.0//binary-client-protocol/key-value-queries" class=''>Key-Value Queries</a></li>
<li><a href="/docs/2.9.0//binary-client-protocol/sql-and-scan-queries" class=''>SQL and Scan Queries</a></li>
<li><a href="/docs/2.9.0//binary-client-protocol/binary-type-metadata" class='active'>Binary Types Metadata</a></li>
<li><a href="/docs/2.9.0//binary-client-protocol/cache-configuration" class=''>Cache Configuration</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>ODBC Driver<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/SQL/ODBC/odbc-driver"
class=''
>ODBC Driver</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/ODBC/connection-string-dsn"
class=''
>Connection String and DSN</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/ODBC/querying-modifying-data"
class=''
>Querying and Modifying Data</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/ODBC/specification"
class=''
>Specification</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/ODBC/data-types"
class=''
>Data Types</a>
</li>
<li>
<a href="/docs/2.9.0/SQL/ODBC/error-codes"
class=''
>Error Codes</a>
</li>
</nav>
</li>
<li>
<a href="/docs/2.9.0/restapi" class='' >REST API</a>
</li>
<li>
<a href="/docs/2.9.0/control-script" class='' >Control Script</a>
</li>
<li>
<a href="/docs/2.9.0/plugins" class='' >Plugins</a>
</li>
<li>
<a href="/docs/2.9.0/sqlline" class='' >SQLLine</a>
</li>
<li>
<button type='button' data-guide-url="" class='group-toggle collapsed '>Ignite for Spark<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/ignite-for-spark/overview"
class=''
>Overview</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/ignitecontext-and-rdd"
class=''
>IgniteContext and IgniteRDD</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/ignite-dataframe"
class=''
>Ignite DataFrame</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/installation"
class=''
>Installation</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/spark-shell"
class=''
>Test Ignite with Spark-shell</a>
</li>
<li>
<a href="/docs/2.9.0/ignite-for-spark/troubleshooting"
class=''
>Troubleshooting</a>
</li>
</nav>
</li>
<li>
<button type='button' data-guide-url="/sql-reference/sql-reference-overview" class='group-toggle collapsed '>SQL Reference<img class="state-indicator" src="/assets/images/left-nav-arrow.svg"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/2.9.0/sql-reference/sql-conformance"
class=''
>SQL Conformance</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/ddl"
class=''
>Data Definition Language (DDL)</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/dml"
class=''
>Data Manipulation Language (DML)</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/transactions"
class=''
>Transactions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/operational-commands"
class=''
>Operational Commands</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/aggregate-functions"
class=''
>Aggregate functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/numeric-functions"
class=''
>Numeric Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/string-functions"
class=''
>String Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/date-time-functions"
class=''
>Data and Time Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/system-functions"
class=''
>System Functions</a>
</li>
<li>
<a href="/docs/2.9.0/sql-reference/data-types"
class=''
>Data Types</a>
</li>
</nav>
</li>
</nav>
<div class="left-nav__overlay"></div>
<article data-swiftype-index='true'>
<a class='edit-link' href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/binary-client-protocol/binary-type-metadata.adoc" target="_blank">Edit</a>
<h1>Binary Type Metadata</h1>
<div class="sect1">
<h2 id="operation-codes">Operation Codes</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Upon a successful handshake with an Ignite server node a client can start performing binary-type related operations by sending a request (see request/response structure below) with a specific operation code:</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 66.6666%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Operation</th>
<th class="tableblock halign-left valign-top">OP_CODE</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_GET_BINARY_TYPE_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_REGISTER_BINARY_TYPE_NAME</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3001</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_GET_BINARY_TYPE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3002</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_PUT_BINARY_TYPE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">3003</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_RESOURCE_CLOSE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>Note that the above mentioned op_codes are part of the request header, as explained <a href="/docs/2.9.0/binary-client-protocol/binary-client-protocol#standard-message-header">here</a>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<h3 id="customs-methods-used-in-sample-code-snippets-implementation" class="discrete">Customs Methods Used in Sample Code Snippets Implementation</h3>
<div class="paragraph">
<p>Some of the code snippets below use <code>readDataObject(&#8230;&#8203;)</code> introduced in <a href="/docs/2.9.0/binary-client-protocol/binary-client-protocol#data-objects">this section</a> and little-endian versions of methods for reading and writing multiple-byte values that are covered in <a href="/docs/2.9.0/binary-client-protocol/binary-client-protocol#data-objects">this example</a>.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="op_get_binary_type_name">OP_GET_BINARY_TYPE_NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets the platform-specific full binary type name by id. For example, .NET and Java can map to the same type Foo, but classes will be Apache.Ignite.Foo in .NET and org.apache.ignite.Foo in Java.</p>
</div>
<div class="paragraph">
<p>Names are registered with OP_REGISTER_BINARY_TYPE_NAME.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Platform id:
JAVA = 0
DOTNET = 1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type id; Java-style hash code of the type name.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Binary type name.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">String</span> <span class="n">type</span> <span class="o">=</span> <span class="s">"ignite.myexamples.model.Person"</span><span class="o">;</span>
<span class="kt">int</span> <span class="n">typeLen</span> <span class="o">=</span> <span class="n">type</span><span class="o">.</span><span class="na">getBytes</span><span class="o">(</span><span class="s">"UTF-8"</span><span class="o">).</span><span class="na">length</span><span class="o">;</span>
<span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">5</span><span class="o">,</span> <span class="no">OP_GET_BINARY_TYPE_NAME</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Platform id</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Type id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">type</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting String</span>
<span class="kt">int</span> <span class="n">typeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// type code</span>
<span class="kt">int</span> <span class="n">strLen</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// length</span>
<span class="kt">byte</span><span class="o">[]</span> <span class="n">buf</span> <span class="o">=</span> <span class="k">new</span> <span class="kt">byte</span><span class="o">[</span><span class="n">strLen</span><span class="o">];</span>
<span class="n">readFully</span><span class="o">(</span><span class="n">in</span><span class="o">,</span> <span class="n">buf</span><span class="o">,</span> <span class="mi">0</span><span class="o">,</span> <span class="n">strLen</span><span class="o">);</span>
<span class="nc">String</span> <span class="n">s</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">String</span><span class="o">(</span><span class="n">buf</span><span class="o">);</span>
<span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">s</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_get_binary_type">OP_GET_BINARY_TYPE</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets the binary type information by id.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type id; Java-style hash code of the type name.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">False: binary type does not exist, response end.
True: binary type exists, response as follows.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type id; Java-style hash code of the type name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Affinity key field name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinaryField count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinaryField * count</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Structure of BinaryField:</p>
<p class="tableblock"><code>String</code> Field name</p>
<p class="tableblock"><code>int</code> Type id; Java-style hash code of the type name.</p>
<p class="tableblock"><code>int</code> Field id; Java-style hash code of the field name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Is Enum or not.</p>
<p class="tableblock">If set to true, then you have to pass the following 2 parameters. Otherwise, skip them.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Pass only if 'is enum' parameter is 'true'</em>.</p>
<p class="tableblock">Enum field count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String + int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><em>Pass only if 'is enum' parameter is 'true'</em>.</p>
<p class="tableblock">Enum values. An enum value is a pair of a literal value (String) and numerical value (int).</p>
<p class="tableblock">Repeat for as many times as the Enum field count that is obtained in the previous parameter.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Schema count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinarySchema</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Structure of BinarySchema:</p>
<p class="tableblock"><code>int</code> Unique schema id.</p>
<p class="tableblock"><code>int</code> Number of fields in the schema.</p>
<p class="tableblock"><code>int</code> Field Id; Java-style hash code of the field name. Repeat for as many times as the total number of fields in the schema.</p>
<p class="tableblock">Repeat for as many times as the BinarySchema count that is obtained in the previous parameter.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">String</span> <span class="n">type</span> <span class="o">=</span> <span class="s">"ignite.myexamples.model.Person"</span><span class="o">;</span>
<span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">4</span><span class="o">,</span> <span class="no">OP_BINARY_TYPE_GET</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Type id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">type</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">boolean</span> <span class="n">typeExist</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">typeId</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="nc">String</span> <span class="n">typeName</span> <span class="o">=</span> <span class="n">readString</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="nc">String</span> <span class="n">affinityFieldName</span> <span class="o">=</span> <span class="n">readString</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">fieldCount</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="n">fieldCount</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span>
<span class="n">readBinaryTypeField</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">boolean</span> <span class="n">isEnum</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">schemaCount</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Read binary schemas</span>
<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="n">schemaCount</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
<span class="kt">int</span> <span class="n">schemaId</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// Schema Id</span>
<span class="kt">int</span> <span class="n">fieldCount</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// field count</span>
<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">j</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">j</span> <span class="o">&lt;</span> <span class="n">fieldCount</span><span class="o">;</span> <span class="n">j</span><span class="o">++)</span> <span class="o">{</span>
<span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">));</span> <span class="c1">// field id</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="kd">private</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">readBinaryTypeField</span> <span class="o">(</span><span class="nc">DataInputStream</span> <span class="n">in</span><span class="o">)</span> <span class="kd">throws</span> <span class="nc">IOException</span><span class="o">{</span>
<span class="nc">String</span> <span class="n">fieldName</span> <span class="o">=</span> <span class="n">readString</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">fieldTypeId</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">fieldId</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">fieldName</span><span class="o">);</span>
<span class="o">}</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_register_binary_type_name">OP_REGISTER_BINARY_TYPE_NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Registers the platform-specific full binary type name by id. For example, .NET and Java can map to the same type Foo, but classes will be Apache.Ignite.Foo in .NET and org.apache.ignite.Foo in Java.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Platform id:
JAVA = 0
DOTNET = 1</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type id; Java-style hash code of the type name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type name.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">String</span> <span class="n">type</span> <span class="o">=</span> <span class="s">"ignite.myexamples.model.Person"</span><span class="o">;</span>
<span class="kt">int</span> <span class="n">typeLen</span> <span class="o">=</span> <span class="n">type</span><span class="o">.</span><span class="na">getBytes</span><span class="o">(</span><span class="s">"UTF-8"</span><span class="o">).</span><span class="na">length</span><span class="o">;</span>
<span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">20</span> <span class="o">+</span> <span class="n">typeLen</span><span class="o">,</span> <span class="no">OP_PUT_BINARY_TYPE_NAME</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">//Platform id</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">//Type id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">type</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Type name</span>
<span class="n">writeString</span><span class="o">(</span><span class="n">type</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_put_binary_type">OP_PUT_BINARY_TYPE</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Registers binary type information in cluster.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type id; Java-style hash code of the type name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Type name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Affinity key field name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinaryField count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinaryField</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Structure of BinaryField:</p>
<p class="tableblock"><code>String</code> Field name</p>
<p class="tableblock"><code>int</code> Type id; Java-style hash code of the type name.</p>
<p class="tableblock"><code>int</code> Field id; Java-style hash code of the field name.</p>
<p class="tableblock">Repeat for as many times as the BinaryField count that is passed in the previous parameter.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Is Enum or not.</p>
<p class="tableblock">If set to true, then you have to pass the following 2 parameters. Otherwise, skip them.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Pass only if 'is enum' parameter is 'true'.</p>
<p class="tableblock">Enum field count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">String + int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Pass only if 'is enum' parameter is 'true'.</p>
<p class="tableblock">Enum values. An enum value is a pair of a literal value (String) and numerical value (int).</p>
<p class="tableblock">Repeat for as many times as the Enum field count that is passed in the previous parameter.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinarySchema count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">BinarySchema</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Structure of BinarySchema:</p>
<p class="tableblock"><code>int</code> Unique schema id.</p>
<p class="tableblock"><code>int</code> Number of fields in the schema.</p>
<p class="tableblock"><code>int</code> Field id; Java-style hash code of the field name. Repeat for as many times as the total number of fields in the schema.</p>
<p class="tableblock">Repeat for as many times as the BinarySchema count that is passed in the previous parameter.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">String</span> <span class="n">type</span> <span class="o">=</span> <span class="s">"ignite.myexamples.model.Person"</span><span class="o">;</span>
<span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">120</span><span class="o">,</span> <span class="no">OP_BINARY_TYPE_PUT</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Type id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">type</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Type name</span>
<span class="n">writeString</span><span class="o">(</span><span class="n">type</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Affinity key field name</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">101</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Field count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Field 1</span>
<span class="nc">String</span> <span class="n">field1</span> <span class="o">=</span> <span class="s">"id"</span><span class="o">;</span>
<span class="n">writeBinaryTypeField</span><span class="o">(</span><span class="n">field1</span><span class="o">,</span> <span class="s">"long"</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Field 2</span>
<span class="nc">String</span> <span class="n">field2</span> <span class="o">=</span> <span class="s">"name"</span><span class="o">;</span>
<span class="n">writeBinaryTypeField</span><span class="o">(</span><span class="n">field2</span><span class="o">,</span> <span class="s">"String"</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Field 3</span>
<span class="nc">String</span> <span class="n">field3</span> <span class="o">=</span> <span class="s">"salary"</span><span class="o">;</span>
<span class="n">writeBinaryTypeField</span><span class="o">(</span><span class="n">field3</span><span class="o">,</span> <span class="s">"int"</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// isEnum</span>
<span class="n">out</span><span class="o">.</span><span class="na">writeBoolean</span><span class="o">(</span><span class="kc">false</span><span class="o">);</span>
<span class="c1">// Schema count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Schema</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">657</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Schema id; can be any custom value</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// field count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">field1</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">field2</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">field3</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="kd">private</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">writeBinaryTypeField</span> <span class="o">(</span><span class="nc">String</span> <span class="n">field</span><span class="o">,</span> <span class="nc">String</span> <span class="n">fieldType</span><span class="o">,</span> <span class="nc">DataOutputStream</span> <span class="n">out</span><span class="o">)</span> <span class="kd">throws</span> <span class="nc">IOException</span><span class="o">{</span>
<span class="n">writeString</span><span class="o">(</span><span class="n">field</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">fieldType</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">field</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="o">}</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="copyright">
© 2020 The Apache Software Foundation.<br/>
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.
</div>
</article>
<nav class="right-nav" data-swiftype-index='false'>
<ul class="sectlevel1">
<li><a href="#operation-codes">Operation Codes</a></li>
<li><a href="#op_get_binary_type_name">OP_GET_BINARY_TYPE_NAME</a></li>
<li><a href="#op_get_binary_type">OP_GET_BINARY_TYPE</a></li>
<li><a href="#op_register_binary_type_name">OP_REGISTER_BINARY_TYPE_NAME</a></li>
<li><a href="#op_put_binary_type">OP_PUT_BINARY_TYPE</a></li>
</ul>
<footer>
</footer>
</nav>
</section>
<script type='module' src='/assets/js/code-copy-to-clipboard.js' async crossorigin></script>
<script>
// inits deep anchors -- needs to be done here because of https://www.bryanbraun.com/anchorjs/#dont-run-it-too-late
anchors.add('.page-docs h1, .page-docs h2, .page-docs h3:not(.discrete), .page-docs h4, .page-docs h5');
anchors.options = {
placement: 'right',
visible: 'always'
};
</script>
<!-- load google fonts async -->
<script type="text/javascript">
WebFontConfig = {
google: { families: [ 'Open+Sans:300,400,600,700&display=swap' ] }
};
(function() {
var wf = document.createElement('script');
wf.src = 'https://ajax.googleapis.com/ajax/libs/webfont/1/webfont.js';
wf.type = 'text/javascript';
wf.async = 'true';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(wf, s);
})(); </script>
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script>
docsearch({
// Your apiKey and indexName will be given to you once
// we create your config
apiKey: '3eee686c0ebe39eff3baeb18c56fa5f8',
indexName: 'apache_ignite',
// Replace inputSelector with a CSS selector
// matching your search input
inputSelector: '#search-input',
// algoliaOptions: { 'facetFilters': ["version:$VERSION"] },
// Set debug to true to inspect the dropdown
debug: false,
});
</script>
<script type='module' src='/assets/js/index.js?1600286556' async crossorigin></script>
<script type='module' src='/assets/js/versioning.js?1600286556' async crossorigin></script>
</body>
</html>