DataTables server-side processing with pipelining example

Preamble

When using server-side processing with DataTables, it can be quite intensive on your server having an Ajax call every time the user performs some kind of interaction - you can effectively DDOS your server with your own application!

This example shows how you might over-come this by modifying the request set to the server to retrieve more information than is actually required for a single page's display. This means that the user can page multiple times (5 times the display size is the default) before a request must be made of the server. Paging is typically the most common interaction performed with a DataTable, so this can be most beneficial to your server's resource usage. Of course the pipeline must be cleared for interactions other than paging (sorting, filtering etc), but that's the trade off that can be made (sending extra information is cheap - while another XHR is expensive).

Live example

Rendering engine Browser Platform(s) Engine version CSS grade
Loading data from server
Rendering engine Browser Platform(s) Engine version CSS grade

Initialisation code

var oCache = {
	iCacheLower: -1
};

function fnSetKey( aoData, sKey, mValue )
{
	for ( var i=0, iLen=aoData.length ; i<iLen ; i++ )
	{
		if ( aoData[i].name == sKey )
		{
			aoData[i].value = mValue;
		}
	}
}

function fnGetKey( aoData, sKey )
{
	for ( var i=0, iLen=aoData.length ; i<iLen ; i++ )
	{
		if ( aoData[i].name == sKey )
		{
			return aoData[i].value;
		}
	}
	return null;
}

function fnDataTablesPipeline ( sSource, aoData, fnCallback ) {
	var iPipe = 5; /* Ajust the pipe size */
	
	var bNeedServer = false;
	var sEcho = fnGetKey(aoData, "sEcho");
	var iRequestStart = fnGetKey(aoData, "iDisplayStart");
	var iRequestLength = fnGetKey(aoData, "iDisplayLength");
	var iRequestEnd = iRequestStart + iRequestLength;
	oCache.iDisplayStart = iRequestStart;
	
	/* outside pipeline? */
	if ( oCache.iCacheLower < 0 || iRequestStart < oCache.iCacheLower || iRequestEnd > oCache.iCacheUpper )
	{
		bNeedServer = true;
	}
	
	/* sorting etc changed? */
	if ( oCache.lastRequest && !bNeedServer )
	{
		for( var i=0, iLen=aoData.length ; i<iLen ; i++ )
		{
			if ( aoData[i].name != "iDisplayStart" && aoData[i].name != "iDisplayLength" && aoData[i].name != "sEcho" )
			{
				if ( aoData[i].value != oCache.lastRequest[i].value )
				{
					bNeedServer = true;
					break;
				}
			}
		}
	}
	
	/* Store the request for checking next time around */
	oCache.lastRequest = aoData.slice();
	
	if ( bNeedServer )
	{
		if ( iRequestStart < oCache.iCacheLower )
		{
			iRequestStart = iRequestStart - (iRequestLength*(iPipe-1));
			if ( iRequestStart < 0 )
			{
				iRequestStart = 0;
			}
		}
		
		oCache.iCacheLower = iRequestStart;
		oCache.iCacheUpper = iRequestStart + (iRequestLength * iPipe);
		oCache.iDisplayLength = fnGetKey( aoData, "iDisplayLength" );
		fnSetKey( aoData, "iDisplayStart", iRequestStart );
		fnSetKey( aoData, "iDisplayLength", iRequestLength*iPipe );
		
		$.getJSON( sSource, aoData, function (json) { 
			/* Callback processing */
			oCache.lastJson = jQuery.extend(true, {}, json);
			
			if ( oCache.iCacheLower != oCache.iDisplayStart )
			{
				json.aaData.splice( 0, oCache.iDisplayStart-oCache.iCacheLower );
			}
			json.aaData.splice( oCache.iDisplayLength, json.aaData.length );
			
			fnCallback(json)
		} );
	}
	else
	{
		json = jQuery.extend(true, {}, oCache.lastJson);
		json.sEcho = sEcho; /* Update the echo for each response */
		json.aaData.splice( 0, iRequestStart-oCache.iCacheLower );
		json.aaData.splice( iRequestLength, json.aaData.length );
		fnCallback(json);
		return;
	}
}

$(document).ready(function() {
	$('#example').dataTable( {
		"bProcessing": true,
		"bServerSide": true,
		"sAjaxSource": "scripts/server_processing.php",
		"fnServerData": fnDataTablesPipeline
	} );
} );

Server response

The code below shows the latest JSON data that has been returned from the server in response to the Ajax request made by DataTables. This will update as further requests are made.


			
			
			

Other examples

le v�lo � tampa (floride) douanes acier courb� sur ont d�voil� leur dernier projet, 1982 honda cb750 d�capotable.dirig� par mike mundy,ADIDAS EQUIPMENT CUSHION 93 la boutique & # 8217;Adidas Climacool Boat Lace s plus r�cente adaptation caract�ristiques l'�quipage & # 8217;ADIDAS TUBULAR SHADOW KNIT s signature minimaliste propre conception avec la peinture gris et noir sur l'ext�rieur.ajouts comprennent un �cran prot�g� phare, red pod filtres et mono - choc springs parmi beaucoup d'autres am�liorations.Adidas Yeezy Boost 350 V2peut - �tre la plus frappante dans le d�tail le tuyau d'�chappement est saillante sous le si�ge.ils a �t� sur un rouleau cette ann�e avec ses nombreuses collaborations et les rejets, et maintenant,ADIDAS ORIGINALS NMD PRIMEKNIT les japonais basket brand,ADIDAS SPRINGBLADE SCHUHE c'est prendre un retour aux sources avec une nouvelle paire de gel lyte vs.ADIDAS TUBULAR WOMENv�tue d'un haut blanc pur nubuck le & # 8220; winter & # 8221;ADIDAS SPRINGBLADE WOMEN SCHUHE pack publication offre une nouvelle nubuck blanc sur la simplicit� comme si�ge haut de la corde d'une semelle intercalaire,ADIDAS CAMPUS tandis que les lacets cravate le chercher ensemble.comme toujours, la nouvelle - # 8220; hiver pack & # 8221; gel lyte v offre confort incomparable avec son gel technologie situ� dans le rembourrage intercalaire.l'asic gel lyte v & # 8220,women's superstar adidas white & # 8221; est maintenant disponible chez les d�taillants comme quelques environ 145 $us.