All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.integration.jdbc.config.spring-integration-jdbc.xsd Maven / Gradle / Ivy




	
	
	

	
		
	

	
		
			
				Defines a MessageStore ('org.springframework.integration.jdbc.JdbcMessageStore')
				backed by a database.
			
		
		
			
				
					
						
							
								Reference to a data source to use to access
								the database. Either this or the jdbc-operations
								must be
								specified (but not both).
							
							
								
									
								
							
						
					
					
						
							
								
									Reference to a JdbcOperations. Either
									this or
									the data-source must be
									specified (but not both).
								
								
									
								
							
						
					
					
						
							
								Unique string to use as a partition for the
								data in this store, so that
								multiple instances can
								share the same
								database tables. The default
								is "DEFAULT".
							
						
					
					
						
							
								Prefix for the table names in the database
								(e.g. so that a schema can be specified, or to avoid
								a clash
								with
								other tables). The default is "INT_".
							
						
					
					
						
							
							
								
									
								
							
						
					
					
						
							
							
								
									
								
							
						
					
					
						
							
							
								
									
								
							
						
					
				
			
		
	

	
		
			
				Defines a Polling Channel Adapter for the
				'org.springframework.integration.jdbc.JdbcPollingChannelAdapter'
				for polling a database.
			
		
		
			
				
					
						
							
								
									
										An update query to execute when a message is
										polled. If the poll is in a transaction then the
										update will roll back if the transaction
										does.
									
								
							
						
						
					
					
					
						
							
								
									An update query to execute when a message is
									polled. If the poll is in a transaction then the
									update will roll back if the transaction does.
									The update can also be specified as a nested element.
								
							
						
					
					
						
							
								
									Flag to indicate whether the update query
									should be executed per message, or per row (in the
									case that a message contains multiple rows).
								
							
						
					
					
						
							
								[DEPRECATED] Limits the number of rows extracted per query (otherwise all rows
								are extracted into the outgoing message).
								Deprecated since 5.1 in favor of 'max-rows'.
							
						
					
					
						
							
								Limits the number of rows extracted per query.
								Otherwise all rows are extracted into the outgoing message.
							
						
					
					
						
							
								
									Reference to a SqlParameterSourceFactory. The input is the result of the
									query. The
									default factory creates a parameter source that treats a List in a special
									way: the parameter name is used as an expression and projected onto the list,
									so for instance "update foos set status=1 where id in (:id)" will generate
									an in clause from the properties "id" of the input list elements.
								
								
									
								
							
						
					
					
						
							
								
									Reference to a static SqlParameterSource for the SELECT query used for polling. If
									that query has
									placeholders (e.g. "SELECT * from FOO where KEY=:key") they
									will be bound from this source by name.
									Note: if you use the framework's 'ExpressionEvaluatingSqlParameterSourceFactory'
									to create a SpEL-based parameter source, be sure to use the
									'createParameterSourceNoCache'
									method so that the expression will be re-evaluated on each poll. See the reference
									documentation for more information.
								
								
									
								
							
						
					
				
			
		
	

	
		
			
				Configures a Consumer Endpoint for the
				'org.springframework.integration.jdbc.JdbcMessageHandler' for updating a
				database.
			
		
		
			
				
					
						
						
					
					
					
						
							
								
									Reference to a SqlParameterSourceFactory. The input is the whole
									outgoing message. The
									default factory creates a bean
									property parameter source so the query can specify named
									parameters like :payload and :headers[foo].
									This attribute is mutually exclusive with the 'prepared-statement-setter'.
								
								
									
								
							
						
					
					
						
							
								
									Reference to a MessagePreparedStatementSetter.
									This attribute is mutually exclusive with the 'sql-parameter-source-factory'.
								
								
									
								
							
						
					
					
						
							
								
									Flag to indicate whether primary keys are generated by the query.
								
							
						
					
					
						
							
								Specifies the order for invocation when this endpoint is connected as a
								subscriber to a SubscribableChannel.
							
						
					
				
			
		
	

	
		
			
				Configures a Consumer Endpoint for the
				'org.springframework.integration.jdbc.JdbcOutboundGateway' for updating a
				database in response to a message on the request channel, and/or
				for retrieving data from the database using the input message as
				a source of parameters for the specified SQL select query.

				The database response will be used to create the response Message
				on the reply channel.

				The response can be created from a query
				supplied here, or (if keys-generated="true") can be the
				primary keys generated from an auto-increment, or else just a
				count of the number of rows affected by the update. The response
				is in general a case insensitive Map (or list of maps if multi-valued), unless
				a select query and a row-mapper is provided. If the update count is
				returned then the map key is "UPDATE".
			
		
		
			
				
					
						
							
								
									
										An update query to be executed when a message is
										received. If this is in a transaction then the
										update will roll back when the transaction does.

										The update can also be specified using the
										"update" attribute.

										Since Spring Integration 2.2 specifying an
										update query is optional, if at least the
										select query is specified.

										If you specify both, update- and select
										query, then the update is executed first.
									
								
							
						
						
						
					
					
					
						
							
								
									An update query to execute when a message is
									received. If this is in a transaction then the
									update will roll back when the transaction does.

									The update can also be specified as a nested element.

									Since Spring Integration 2.2 specifying an
									update query is optional, if at least the
									select query is specified.

									If you specify both, update- and select
									query, then the update is executed first.
								
							
						
					
					
						
							
								When using a select query, you can set a
								custom limit regarding the number of rows
								extracted. Otherwise by default only the first
								row will be extracted into the outgoing message.
								If set to '0' all rows are extracted.
							
						
					
					
						
							
								
									Reference to a SqlParameterSourceFactory. The input is the whole
									outgoing message. The
									default factory creates a bean
									property parameter source so the query can specify named
									parameters like :payload and :headers[foo].
									This attribute is mutually exclusive with the 'request-prepared-statement-setter'.
								
								
									
								
							
						
					
					
						
							
								
									Reference to a MessagePreparedStatementSetter.
									This attribute is mutually exclusive with the
									'request-sql-parameter-source-factory'.
								
								
									
								
							
						
					
					
						
							
								
									Reference to a SqlParameterSourceFactory. The input is the whole
									outgoing message. The
									default factory creates a bean
									property parameter source so the query can specify named
									parameters like :payload and :headers[foo].
								
								
									
								
							
						
					
					
						
							
								The receiving Message Channel of this endpoint.
							
							
								
									
								
							
						
					
					
						
							
								Message Channel to which replies should be sent,
								after receiving the database response.
							
							
								
									
								
							
						
					
					
						
							
						
					
					
						
							
								
									Flag to indicate whether primary keys are generated by the query. If they are then
									they can be used as a reply payload instead of providing a select query. A single
									valued result is extracted before returning (the usual case), so the payload of the
									reply message
									can be a Map (column name to value) or a list of maps.
								
							
						
					
					
						
							
								Specifies the order for invocation when this endpoint is connected as a
								subscriber to a SubscribableChannel.
							
						
					
					
						
							
								Specify whether this outbound gateway must return a non-null value. This value is
								'true' by default, and a ReplyRequiredException will be thrown when
								the underlying service returns a null value.
							
						
					
					
				
			
		
	

	
		
			
				
					Reference to a data source to use to access the database.
					Either this or the simple-jdbc-operations must be specified
					(but not both).
				
				
					
						
					
				
			
		
		
			
				
					
						Reference to a JdbcOperations. Either this or the
						data-source must be specified (but not both).
					
					
						
					
				
			
		
	

	
		
			
				
					
						
							
								
									A select query to execute when a message is
									polled. In general the query can return multiple
									rows, because the result will be a List (of
									type determined by the row mapper).
								
							
						
					
				
				
					
						
							
								A select query to execute when a message is
								polled. In general the query can return multiple
								rows, because
								the result will be a List (of type determined by the row
								mapper). The query can also be specified as
								a nested element.
							
						
					
				
			
		
	

	
		
			
				
					
						
							
								Reference to a row mapper to use to convert
								JDBC result set rows to message payloads. Optional
								with default that maps result set row to a map
								(column name to column value).
								Other simple use cases can be handled with
								out-of-the box implementations from Spring JDBC.
								Others require a custom row mapper.
							
							
								
							
						
					
				
			
		
	

	
		
			
				Configures a Consumer Endpoint for the
				'org.springframework.integration.jdbc.StoredProcMessageHandler' for updating a
				database using stored procedures.
			
		
		
			
				
				
					
						
						
					
				
				
					
						
							
						
					
				
				
			
			
			
				
					
						
					
				
				
					
				
			
			
				
					
						
							Reference to a SqlParameterSourceFactory.
						
						
							
						
					
				
			
			
				
					
						
							Channel from which messages will be output.
							When a message is sent to this channel it will
							cause the query
							to be executed.
						
						
							
						
					
				
			
			
				
					
						Specifies the order for invocation when this endpoint is connected as a
						subscriber to a SubscribableChannel.
					
				
			
		
	

	
		
			
				Configures a Consumer Endpoint for the
				'org.springframework.integration.jdbc.StoredProcOutboundGateway' for updating a database using
				a stored procedure. The response of the stored procedure is used
				to populate the Message for the reply channel.
			
		
		
			
				
					
					
						
							
							
						
					
					
						
							
								
							
						
					
					
						
							
								
							
						
					
					
				
			
			
			
				
					
						
					
				
				
					
				
			
			
				
					
						
							Reference to a SqlParameterSourceFactory. The input is the whole
							outgoing message. The
							default factory creates a bean
							property parameter source so the query can specify named
							parameters like :payload and :headers[foo].
						
						
							
						
					
				
			
			
				
					
						If "true", a SQL Function is called. In that case
						the "stored-procedure-name" attribute defines
						the name of the called function.
					
				
				
					
				
			
			
				
					
					
				
				
					
				
			
			
				
					
					
				
				
					
				
			
			
				
					
						The receiving Message Channel of this endpoint.
					
					
						
							
						
					
				
			
			
				
					
						Message Channel to which replies should be sent,
						after receiving the database response.
					
					
						
							
						
					
				
			
			
				
					
				
			
			
				
					
						Specifies the order for invocation when this endpoint is connected as a
						subscriber to a SubscribableChannel.
					
				
			
			
				
					
						Indicates the procedure's return value should be included
						in the results returned.
					
				
				
					
				
			
			
				
					
						Specify whether this outbound gateway must return a non-null value. This value is
						'false' by default, if it set to 'true', a ReplyRequiredException will be thrown when
						the underlying service returns a null value.
					
				
			
		
	

	
		
			
				Defines a Polling Channel Adapter for the
				'org.springframework.integration.jdbc.StoredProcPollingChannelAdapter' for polling a
				database using a stored procedure or function.
			
		
		
			
				
				
					
						
							
						
					
				
				
					
						
							
						
					
				
				
					
						
							
						
					
				
			
			
			
				
					
						If "true", a SQL Function is called. In that case
						the "stored-procedure-name" attribute defines
						the name of the called function.
					
				
				
					
				
			
			
				
					
					
				
				
					
				
			
			
				
					
					
				
				
					
				
			
			
				
					
						Indicates the procedure's return value should be included
						in the results returned.
					
				
				
					
				
			
			
				
					
						Channel to which polled messages will be send. If the stored
						procedure or function does not return any data, the payload
						of the Message will be Null.
					
					
						
							
						
					
				
			
		
	

	
		
			
				
					Identifies the underlying Spring bean definition, which is an
					instance of either 'EventDrivenConsumer' or 'PollingConsumer',
					depending on whether the component's input channel is a
					'SubscribableChannel' or 'PollableChannel'.
				
			
		
		
			
				
					The name of the stored procedure. If the "is-function"
					attribute is "true", this attributes specifies the
					function name.
				
			
		
		
			
				
					The name of the stored procedure provided as a SpEL expression.
					Components that use a Message as source of parameters have
					full access to the message and its headers, in order to
					derive a stored procedure name.

					The expression must resolve to a String.
				
			
		
		
			
				
					Defines the maximum number of cached SimpleJdbcCallOperations
					instances. Basically, for each Stored Procedure Name a new
					SimpleJdbcCallOperations instance is created that in return
					is being cached. The default cache size is '10'. A value of
					'0' disables caching. Negative values are not permitted.
				
			
			
				
			
		
		
			
				
					Reference to a data source to use to access
					the database.
				
				
					
						
					
				
			
		
		
		
			
				
					If true, the JDBC parameter definitions for the stored procedure
					are not automatically derived from the underlying JDBC connection. In
					that case you must specify all Sql parameter definitions explicitly
					using the 'sql-parameter-definition' sub-element.
				
			
			
				
			
		
	

	
		
			
				
			
		
		
			
				
			
		
		
			
				
			
		
		
			
				
			
		
	

	
		
			
				
			
		
		
			
				
					
						Reference to a row mapper to use to convert
						JDBC result set rows to message payloads.
					
					
						
					
				
			
		
	

	
		
			
				
			
		
		
			
				
			
			
				
			
		
		
			
				
			
			
				
			
		
		
			
				
			
		
		
			
				
			
		
		
			
				
					
						Reference to a custom value handler for complex type.
					
					
						
					
				
			
		
	

	
		
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
			
		
	

	
		
			
			
			
		
	





© 2015 - 2024 Weber Informatics LLC | Privacy Policy